{"_id":"5c6c23e4735b81006177d04f","category":{"_id":"5c6c23e4735b81006177d011","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T17:35:06.626Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":24,"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.\",\n    \"3-0\": \"`email`\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Payer's email address.\\nBetween 3-100 characters.\",\n    \"3-1\": \"*string*\",\n    \"1-0\": \"`lastName`\",\n    \"1-1\": \"*string*\",\n    \"1-3\": \"Payer's last name.\\nMaximum 100 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, it is necessary to 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    \"4-2\": \"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.\\nBetween 2-36 characters.\\nAccepts numbers, letters, and these characters: ** + . * # / \\\\ ( ) - **\",\n    \"8-3\": \"Payer's city.\\nBetween 2-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 (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    \"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, up to 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.\\nBetween 3-100 characters.\",\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.\\nMaximum 100 characters.\",\n    \"1-2\": \"Payer's last name.\\nMaximum 100 characters.\",\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.\\nMaximum 100 characters.\",\n    \"8-2\": \"Payer's city.\\nBetween 2-42 characters.\",\n    \"9-2\": \"Payer's ZIP code.\",\n    \"10-2\": \"Payer's phone number.\\nBetween 2-36 characters.\",\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.\\nMaximum 100 characters.\",\n    \"3-1\": \"*string*\",\n    \"3-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    \"3-0\": \"`personalIdentificationNumber`\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","excerpt":"Contains information about a shopper who is paying with the alternative payment method","slug":"payer-info","type":"basic","title":"payerInfo"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

payerInfo

Contains information about a shopper who is paying with the alternative payment method

Request

Property Name
Type
Required
Description

firstName

string

Required

Payer's first name.
Maximum 100 characters.

lastName

string

Required

Payer's last name.
Maximum 100 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 (length 7-11 chars)
  • Brazil - CPF/CNPJ (length 11-14 chras)
  • Chile - RUN (length 8-9 chars)
  • Mexico - CURP/RFC (length 10-18 chars)

email

string

Optional

Payer's email address.
Between 3-100 characters.

country

string

Optional

Payer's country code.
See Country codes

state

string

Optional

Payer's state code.
See State and province codes
Supports US and Canada states only. For states in other countries, it is necessary to 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.
Between 2-42 characters.

zip

string

Optional

Payer's ZIP code.
Maximum 20 characters.

phone

string

Optional

Payer's phone number.
Between 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, up to 50 characters.

Response

Property Name
Type
Description

firstName

string

Payer's first name.
Maximum 100 characters.

lastName

string

Payer's last name.
Maximum 100 characters.

email

string

Payer's email address.
Between 3-100 characters.

personalIdentificationNumber

string

The shopper's local personal identification number. These are the ID types per country:

  • Argentina - DNI (length 7-11 chars)
  • Brazil - CPF/CNPJ (length 11-14 chras)
  • Chile - RUN (length 8-9 chars)
  • Mexico - CURP/RFC (length 10-18 chars)

country

string

Payer's country code.
See Country codes

state

string

Payer's state code.
See State and province codes

address

string

Payer's address line 1.
Maximum 100 characters.

address2

string

Payer's address line 2.
Maximum 100 characters.

city

string

Payer's city.
Between 2-42 characters.

zip

string

Payer's ZIP code.

phone

string

Payer's phone number.
Between 2-36 characters.