ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
| Field name | Format | Description | Default | Validations | |
|---|---|---|---|---|---|
| Field name | Format | Description | Default | Validations | Required |
country | string (length: 2) | Country code of the deposit in ISO 3166-1 alpha-2 code format | Country codes | Yes | |
amount | decimal (max decimals: 2) | Deposit amount in the currency specified | Number of up to 18 integers and 2 decimals places | Yes | |
currency | string (length: 3) | Currency code of the amount in ISO 4217 format | USD | See Currencies | Yes |
installments | integer (max length: 2) | Number of installments in which the deposit will take place. *Check eligibility with your commercial contact. | Integer number between 1 and 12. | No | |
invoice_id | string (max length: 128) | Unique deposit ID on the merchant end | random | ^[A-Za-z0-9-_]*$ | Yes |
payer | object[] | Object containing details about the payer | Payer object | Yes | |
credit_card | object[] | Object containing the credit card details | Credit card object | Yes | |
description | string (max length: 100) | Transaction description. It could be shown on the customers credit card extract | String of up to 100 characters | No | |
client_ip | string | Valid IPv4 or IPv6 Address | IPv4/v6 Address | Yes | |
device_id | string (max length: 100) | Unique customer's device ID. Used to identify and prevent fraud. | String of up to 100 characters | No | |
card_token | string (max length: 50) | Card Token generated with Cards SDK Without User Interface. | String of up to 50 characters | No | |
fee_on_payer | boolean | Choose if the deposit's fee will be paid by the customer or debited from your balance | false | [true, false] | No |
^\d{3,4}$
size must be between 3 and 4
| Yes | | `card_number` | String (max length: 16 digits) | The credit card number consisting of up to 16 digits | [Luhn Algorithm](https://en.wikipedia.org/wiki/Luhn_algorithm) | Yes | | `expiration_month` | String(length: 2) | Credit card expiration month | `^(1[0-2]\|0[1-9]\|[1-9])$` | Yes | | `expiration_year` | String(length: 2) | Credit card expiration year last two digits |^\d{2}$
Valid year: 25
| Yes | | `holder_name` | String (max length: 256) | The name of the credit card owner | Valid name | Yes | ### Payer Object| Field name | Format | Description | Default | Validations | |
|---|---|---|---|---|---|
| Field name | Format | Description | Default | Validations | Required |
id | string (max length: 128) | Customer's ID generated on your end. Used to locate user's transaction on our Merchant Panel | If none is sent, we will autogenerate it | ^[A-Za-z0-9]*$ | Recommended |
document | string (max length: 30) | Customer's document ID. Ensure it is correct and the user can't change it every time he/she deposits | document validations | Yes | |
document_type | string (max length: 10) | Customer's document type. Optional, if sent must be a valid document type | document types validations | Yes | |
email | string (max length: 255) | Valid customer's email address | Valid email address | Yes | |
first_name | string (max length: 128) | Customer's first name | String of up to 128 characters | Yes | |
last_name | string (max length: 128) | Customer's last name | String of up to 128 characters | Yes | |
address | object[] | Object containing customer's address details | address object | No | |
phone | string (max length: 32) | Valid customer's phone number | phone number validations | No | |
birth_date | string (max length: 8) | Customer's birthdate in format yyyyMMdd. E.g.: 19801027 | Numeric format expected: yyyyMMdd | No |