customer_id
|
string
min: 1 | max: 255
|
required
|
The customer id stored on your platform for future identification.
|
branch
|
string
min: 1 | max: 255
|
optional
|
When the merchant needs to keep track of its various offices / branch, this field must be fill.
|
name
|
string
min: 3 | max: 150
|
required
|
Name of the customer who started the transaction.
|
email
|
string
min: 30 | max: 255
|
required
|
Email of the customer who started the transaction.
|
document
|
string
Format: 99999999999
|
required
|
Brazilian document (CPF) of the customer who started the transaction.
- Must be a valid CPF document;
Eg: 12345678909
|
amount
|
decimal (10,2)
min: 2
|
required
|
The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)
Eg: 300.10
|
currency
|
string (3)
(USD or BRL)
min: 3 | max: 3
|
optional
|
The currency type that the amount will be credited. If USD is provided there will be a conversion from USD to BRL, if BRL is provided there will be no conversion.
This parameter is optional, if currency isn't provided it will auto-select USD.
Default: USD
|
callback
|
string
min: 30 | max: 250
(Method: POST)
|
required
|
The URL in you site that our API will notify when the payment changes the status, the HTTP supported method should be HTTP
Eg: http://my-url-callback/
|
transaction
|
id
|
string
min: 1 | max: 255
|
required
|
The id of the transaction generated in you platform.
|
bank
|
IMPORTANT: If you enter any bank field then
name ,
code ,
agency ,
account ,
account_operation
are required. And Pix field cannot be informed.
|
name
|
string
min: 3 | max: 255
|
|
The name of the bank
|
code
|
string
min: 1 | max: 10
|
|
The code of the bank provided by Banco Central (BC)
|
agency
|
string
min: 4| max: 10
|
|
The number of the bank agency that client have opened their account
|
account
|
string
min: 3 | max: 80
|
|
The number of the bank account of the client
|
account_operation
|
string
min: 3 | max: 80
|
|
The operation number or code of the bank account, some accounts have that code like Caixa Economica Federal in their saving account (conta poupança). It has the operation code 013. This field is not required, some banks don't have this code
|
pix
|
IMPORTANT: If you enter any pix field then
key
is required. And Bank field cannot be informed.
|
key
|
string
min: 3 | max: 250
|
|
Pix key or reference
|