{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"batchTransaction","type":"basic","slug":"batch-transaction","excerpt":"Contains billing contact information","body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`batchId`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"First name for billing.\\nMaximum 100 characters.\",\n    \"1-0\": \"`callbackUrl`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Last name for billing.\\nMaximum 100 characters.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"5-0\": \"`state`\",\n    \"6-0\": \"`zip`\",\n    \"5-3\": \"State code for billing.\\nSee [State and province codes](/docs/state-and-province-codes).\\nSupports US and Canada states only. For states in other countries, it is necessary to include the state within the `address1` or `address2` property.\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"6-3\": \"ZIP code for billing. \\nMaximum 20 characters.\",\n    \"5-2\": \"Optional\",\n    \"6-2\": \"**Required**\",\n    \"7-0\": \"`country`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"**Required**\",\n    \"7-3\": \"Country code for billing.\\nSee [Country codes](/docs/country-codes).\",\n    \"2-0\": \"`cardTransaction`\",\n    \"3-0\": \"`altTransaction`\",\n    \"2-1\": \"container\",\n    \"3-1\": \"container\",\n    \"2-2\": \"Optional\",\n    \"3-2\": \"Optional\",\n    \"2-3\": \"Address line 1 for billing.\\nMaximum 100 characters.\",\n    \"3-3\": \"Address line 2 for billing.\\nBetween 2-42 characters.\",\n    \"4-0\": \"`city`\",\n    \"4-1\": \"*string*\",\n    \"4-3\": \"City for billing.\\nBetween 2-42 characters.\",\n    \"4-2\": \"**Required**\",\n    \"8-0\": \"`personalIdentificationNumber`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"**Required** for [local LatAm processing](/docs/latam-local-processing) in Brazil; Optional for all other Latam countries.\",\n    \"8-3\": \"The shopper's local personal identification number. These are the ID types per country:\\n\\n  * Argentina - DNI (length 7-11 chars)\\n  * Brazil - CPF/CNPJ (length 11-14 chras)\\n  * Chile - RUN (length 8-9 chars)\\n  * Mexico - CURP/RFC (length 10-18 chars)\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`batchId`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Cardholder's first name.\",\n    \"1-0\": \"`callbackUrl`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Cardholder's last name.\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"Unique ID provided by the merchant.\",\n    \"1-2\": \"URL where BlueSnap sends the full batch result once all transactions are processed.\",\n    \"4-0\": \"`altTransaction`\",\n    \"4-1\": \"container\",\n    \"5-0\": \"`processingInfo`\",\n    \"6-0\": \"`zip`\",\n    \"5-3\": \"Cardholder's state code.\\n\\nADD LINK TO LIST OF STATE CODES\",\n    \"5-1\": \"container\",\n    \"6-1\": \"*string*\",\n    \"6-3\": \"Cardholder's address.\",\n    \"4-3\": \"Cardholder's country code.\\n\\nADD LINK TO LIST OF COUNTRY CODES\",\n    \"4-2\": \"Container of [altTransaction](doc:alt-transaction) properties.\",\n    \"5-2\": \"Container of [processingInfo](doc:processing-info) properties.\",\n    \"6-2\": \"ZIP code for billing.\\nMaximum 20 characters.\",\n    \"7-0\": \"`country`\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"Country code for billing.\\nSee [Country codes](/docs/country-codes).\",\n    \"3-0\": \"`cardTransaction`\",\n    \"2-0\": \"`transactionCount`\",\n    \"2-1\": \"*integer*\",\n    \"3-1\": \"container\",\n    \"2-2\": \"Number of transactions in the batch.\",\n    \"3-2\": \"Container of [cardTransaction](doc:card-transaction) properties.\",\n    \"8-0\": \"`personalIdentificationNumber`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"The shopper's local personal identification number. These are the ID types per country:\\n\\n  * Argentina - DNI (length 7-11 chars)\\n  * Brazil - CPF/CNPJ (length 11-14 chras)\\n  * Chile - RUN (length 8-9 chars)\\n  * Mexico - CURP/RFC (length 10-18 chars)\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61310ed1ca5f87007148e8ca","createdAt":"2021-09-02T17:50:09.090Z","user":"606df105d9ab93003f73cb10","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"60fed21a76106200102eae15","version":"60fed21a76106200102eaec3","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.39 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60fed21a76106200102eae0a","60fed21a76106200102eae0b","60fed21a76106200102eae0c","60fed21a76106200102eae0d","60fed21a76106200102eae0e","60fed21a76106200102eae0f","60fed21a76106200102eae10","60fed21a76106200102eae11","60fed21a76106200102eae12","60fed21a76106200102eae13","60fed21a76106200102eae14","60fed21a76106200102eae15","60fed21a76106200102eae16","60fed21a76106200102eae17","60fed21a76106200102eae18","60fed21a76106200102eae19","60fed21a76106200102eae1a","60fed21a76106200102eae1b","60fed21a76106200102eae1c","613a2bc99ca316007473ee77"],"_id":"60fed21a76106200102eaec3","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"60a40b18fa93ca00237af576","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

batchTransaction

Contains billing contact information

Request

Property Name
Type
Required
Description

batchId

string

Required

First name for billing.
Maximum 100 characters.

callbackUrl

string

Required

Last name for billing.
Maximum 100 characters.

cardTransaction

container

Optional

Address line 1 for billing.
Maximum 100 characters.

altTransaction

container

Optional

Address line 2 for billing.
Between 2-42 characters.

Response

Property Name
Type
Description

batchId

string

Unique ID provided by the merchant.

callbackUrl

string

URL where BlueSnap sends the full batch result once all transactions are processed.

transactionCount

integer

Number of transactions in the batch.

cardTransaction

container

Container of cardTransaction properties.

altTransaction

container

Container of altTransaction properties.

processingInfo

container

Container of processingInfo properties.