{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"payerInfo","type":"basic","slug":"payer-info","excerpt":"Contains information about a shopper who is paying with the alternative payment method","body":"###Request\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"0-0\": \"`firstName`\",\n \"0-1\": \"*string*\",\n \"h-3\": \"Description\",\n \"0-3\": \"Payer's first name.\\nMaximum 100 characters.\\nFor ACH/ECP, the limit is 25 characters.\",\n \"3-0\": \"`email`\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Payer's email address.\\n3–100 characters.\",\n \"3-1\": \"*string*\",\n \"1-0\": \"`lastName`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"Payer's last name.\\nMaximum 100 characters.\\nFor ACH/ECP, the limit is 25 characters.\",\n \"3-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n \"h-4\": \"Description\",\n \"0-2\": \"**Required**\",\n \"1-2\": \"**Required**\",\n \"4-0\": \"`country`\",\n \"4-1\": \"*string*\",\n \"5-0\": \"`state`\",\n \"6-0\": \"`address`\",\n \"5-3\": \"Payer's state code.\\nSee [State and province codes](/docs/state-and-province-codes)\\nSupports US and Canada states only. For states in other countries, you must include the state within the `address` property.\",\n \"5-1\": \"*string*\",\n \"8-0\": \"`city`\",\n \"6-1\": \"*string*\",\n \"9-0\": \"`zip`\",\n \"8-1\": \"*string*\",\n \"9-1\": \"*string*\",\n \"10-0\": \"`phone`\",\n \"6-3\": \"Payer's address line 1.\\nMaximum 100 characters.\",\n \"4-3\": \"Payer's country code.\\nSee [Country codes](/docs/country-codes). \\n\\nFor **iDEAL** transactions, the default value is **nl**.\",\n \"4-2\": \"Required for [Create LBT transaction](https://developers.bluesnap.com/v8976-JSON/docs/create-lbt-transaction)\\nOtherwise, this is optional.\",\n \"5-2\": \"Optional\",\n \"6-2\": \"Optional\",\n \"8-2\": \"Optional\",\n \"9-2\": \"Optional\",\n \"10-2\": \"Optional\",\n \"10-3\": \"Payer's phone number.\\n2–36 characters.\\nAccepts numbers, letters, and these characters: **` + . * # / \\\\ ( ) - `**\",\n \"8-3\": \"Payer's city.\\n2–42 characters.\",\n \"9-3\": \"Payer's ZIP code. \\nMaximum 20 characters.\",\n \"10-1\": \"*string*\",\n \"7-0\": \"`address2`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Optional\",\n \"7-3\": \"Payer's address line 2.\\nMaximum 100 characters.\",\n \"2-2\": \"Required for [local LatAm processing](/docs/latam-local-processing) in Brazil\",\n \"2-1\": \"*string*\",\n \"2-3\": \"The shopper's local personal identification number. These are the ID types per country\\n\\n * Argentina: DNI (7–11 char)\\n * Brazil: CPF/CNPJ (11–14 char)\\n * Chile: RUN (8–9 char)\\n * Mexico: CURP/RFC (10–18 char)\",\n \"2-0\": \"`personalIdentificationNumber`\",\n \"12-0\": \"`merchantShopperId`\",\n \"12-1\": \"*string*\",\n \"12-2\": \"Optional\",\n \"12-3\": \"A merchant's ID for a specific shopper.\\nMaximum 50 characters.\",\n \"11-0\": \"`companyName`\",\n \"11-1\": \"*string*\",\n \"11-2\": \"Optional\",\n \"11-3\": \"Name of merchant's company. \\nMaximum 50 characters. \\n\\n**Note**: Required if payment type is ECP and `accountType` is: \\n* CORPORATE_CHECKING\\n* CORPORATE_SAVINGS\"\n },\n \"cols\": 4,\n \"rows\": 13\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\": \"`firstName`\",\n \"0-1\": \" *string* \",\n \"h-3\": \"Description\",\n \"0-3\": \"Cardholder's first name.\",\n \"2-0\": \"`email`\",\n \"2-2\": \"Payer's email address.\",\n \"2-3\": \"Cardholder's email address.\",\n \"2-1\": \"*string*\",\n \"1-0\": \"`lastName`\",\n \"1-1\": \"*string*\",\n \"1-3\": \"Cardholder's last name.\",\n \"2-4\": \"A container of card-transaction properties.\\nThis property may appear more than once within the given resource.\",\n \"h-4\": \"Description\",\n \"0-2\": \"Payer's first name.\",\n \"1-2\": \"Payer's last name.\",\n \"4-0\": \"`country`\",\n \"4-1\": \"*string*\",\n \"5-0\": \"`state`\",\n \"6-0\": \"`address`\",\n \"5-3\": \"Cardholder's state code.\\n\\nADD LINK TO LIST OF STATE CODES\",\n \"5-1\": \"*string*\",\n \"8-0\": \"`city`\",\n \"6-1\": \"*string*\",\n \"9-0\": \"`zip`\",\n \"8-1\": \"*string*\",\n \"9-1\": \"*string*\",\n \"10-0\": \"`phone`\",\n \"6-3\": \"Cardholder's address.\",\n \"4-3\": \"Cardholder's country code.\\n\\nADD LINK TO LIST OF COUNTRY CODES\",\n \"4-2\": \"Payer's country code.\\nSee [Country codes](/docs/country-codes)\",\n \"5-2\": \"Payer's state code.\\nSee [State and province codes](/docs/state-and-province-codes)\",\n \"6-2\": \"Payer's address line 1.\",\n \"8-2\": \"Payer's city.\",\n \"9-2\": \"Payer's ZIP code.\",\n \"10-2\": \"Payer's phone number.\",\n \"10-3\": \"Cardholder's phone number.\",\n \"8-3\": \"Cardholder's city.\",\n \"9-3\": \"Cardholder's ZIP code.\",\n \"10-1\": \"*string*\",\n \"7-0\": \"`address2`\",\n \"7-1\": \"*string*\",\n \"7-2\": \"Payer's address line 2.\",\n \"3-1\": \"*string*\",\n \"3-2\": \"The shopper's local personal identification number. \\nThese are the ID types per country:\\n\\n * Argentina: DNI\\n * Brazil: CPF/CNPJ\\n * Chile: RUN\\n * Mexico: CURP/RFC\",\n \"3-0\": \"`personalIdentificationNumber`\"\n },\n \"cols\": 3,\n \"rows\": 11\n}\n[/block]","updates":[],"order":28,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f43d7db37d54d01d8ef0811","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":14,"from_sync":false,"reference":false,"_id":"5f43d7db37d54d01d8ef07d6","version":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.35 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f43d7db37d54d01d8ef07cb","5f43d7db37d54d01d8ef07cc","5f43d7db37d54d01d8ef07cd","5f43d7db37d54d01d8ef07ce","5f43d7db37d54d01d8ef07cf","5f43d7db37d54d01d8ef07d0","5f43d7db37d54d01d8ef07d1","5f43d7db37d54d01d8ef07d2","5f43d7db37d54d01d8ef07d3","5f43d7db37d54d01d8ef07d4","5f43d7db37d54d01d8ef07d5","5f43d7db37d54d01d8ef07d6","5f43d7db37d54d01d8ef07d7","5f43d7db37d54d01d8ef07d8","5f43d7db37d54d01d8ef07d9","5f43d7db37d54d01d8ef07da","5f43d7db37d54d01d8ef07db","5f45521ec5bfe9005a858533"],"_id":"5f43d7db37d54d01d8ef0876","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5ed0377101fdb400214dedaa","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-01-06T17:35:06.626Z","githubsync":"","__v":0}payerInfo
Contains information about a shopper who is paying with the alternative payment method
Property Name
Type
Required
Description
firstName
string
Required
Payer's first name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.
lastName
string
Required
Payer's last name.
Maximum 100 characters.
For ACH/ECP, the limit is 25 characters.
personalIdentificationNumber
string
Required for local LatAm processing in Brazil
The shopper's local personal identification number. These are the ID types per country
- Argentina: DNI (7–11 char)
- Brazil: CPF/CNPJ (11–14 char)
- Chile: RUN (8–9 char)
- Mexico: CURP/RFC (10–18 char)
email
string
Optional
Payer's email address.
3–100 characters.
country
string
Required for Create LBT transaction
Otherwise, this is optional.
Payer's country code.
See Country codes.
For iDEAL transactions, the default value is nl.
state
string
Optional
Payer's state code.
See State and province codes
Supports US and Canada states only. For states in other countries, you must include the state within the address property.
address
string
Optional
Payer's address line 1.
Maximum 100 characters.
address2
string
Optional
Payer's address line 2.
Maximum 100 characters.
city
string
Optional
Payer's city.
2–42 characters.
zip
string
Optional
Payer's ZIP code.
Maximum 20 characters.
phone
string
Optional
Payer's phone number.
2–36 characters.
Accepts numbers, letters, and these characters: + . * # / \ ( ) -
companyName
string
Optional
Name of merchant's company.
Maximum 50 characters.
Note: Required if payment type is ECP and accountType is:
- CORPORATE_CHECKING
- CORPORATE_SAVINGS
merchantShopperId
string
Optional
A merchant's ID for a specific shopper.
Maximum 50 characters.
Property Name
Type
Description
firstName
string
Payer's first name.
lastName
string
Payer's last name.
email
string
Payer's email address.
personalIdentificationNumber
string
The shopper's local personal identification number.
These are the ID types per country:
- Argentina: DNI
- Brazil: CPF/CNPJ
- Chile: RUN
- Mexico: CURP/RFC
address
string
Payer's address line 1.
address2
string
Payer's address line 2.
city
string
Payer's city.
zip
string
Payer's ZIP code.
phone
string
Payer's phone number.
