...
Name | Description | Format | Example | ||
| Authorization Bearer (Header) | Authentication token used to identify the merchant. | AN [a-zA-Z0- 9_] | Bearer OGE4Mjk0MTg0ZTczNjAxMjAxNGU3OGExN2E2YTE1YjB8ZjJGRUtacXRCUA== | ||
amount | Amount of the payment request. The dot is used as a decimal separator. | N13 [0- 9]{1,10}\.[0 -9]{2} | 1.00 | ||
currency | Currency Code according to ISO 4217 specifications of the payment request’s amount | A3 [a-zA-Z]{3} | BRL | ||
paymentBrand | The brand specifies the method for the request | AN32 [a-zA-Z0- 9_] {1,32} | BOLETO | ||
paymentType | The payment type for the request | A2 | PA | Authentication.userID | The userId for the entity. Required for a server-to-server request|
Authentication.password | The password for the entity (channel). Required for a server-to-server request | authentication.entityId | The entity for the request. (e.g. channel) | AN32 [a-zA-Z0- 9]{32} | 8a8294174ae82ada014 aedfd75aa1d79 |
customer.email | The (internal) email address of the customer | AN128 [\s\S]{6,12 8} | |||
customer.ip | AN255 [\s\S]{1,25 5} | AN255 [\s\S]{1,25 5} | 1.1.1.1 | ||
customer.identificationDocId | CPF number of customer | N11 | 70383053102 | ||
merchantTransactionID | Merchant-provided reference number | AN255 [\s\S]{1,25 5} | 1234 | ||
customParameters[CUSTOM_due_date] | Due Date of the Boleto. Recommended: 3 days in the future. Format: DDMMYYYY | AN10 {19|20}([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]) | 21012016 |
...