Payments
Call the Payments API to request payments via Bank Transfer or PIX.
POST /v1/payment
Request
Parameters details
customer_id
string
min: 1 | max: 255
yes
The customer id stored on your platform for future identification.
branch
string
min: 1 | max: 255
no
When the merchant needs to keep track of its various offices / branch, this field must be fill.
name
string
min: 3 | max: 150
yes
Name of the customer who started the transaction.
email
string
min: 30 | max: 255
yes
Email of the customer who started the transaction.
document
string
Format: 99999999999
yes
Brazilian document (CPF) of the customer who started the transaction.
- Must be a valid CPF document;
Eg: 12345678909
amount
decimal (10,2)
min: 2
yes
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
no
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
payment_method
string
(bank_transfer or pix)
min: 3 | max: 13
yes
The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.
callback
string
min: 30 | max: 250
(Method: POST)
yes
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
yes
The id of the transaction generated in you platform.
pix
expire_in
integer (11)
no
Lifetime of the charge, specified in seconds from the creation date, so that the charge payment can be made. If not informed, the duration is assumed to be 1800 seconds, which corresponds to 30 minutes.
Response (PIX)
Response (Bank Transfer)
Response details
id
status
The current status of the payment. These are our statuses: pending
, paid
, denied
, expired
payment
method
The payment method chosen. bank_transfer
or pix
values
total
The full value of the transaction, including service fees. Decimal separator it a dot
subtotal
The value of the transaction, without service fees. Decimal separator it a dot
exchange
The exchange rate applied to the current transaction
fee
The service fee value
bank
name
Name of the bank where the deposit is going to be made
code
Brazilian code of the bank to which the deposit is going to be directed
agency
Agency number with verification digit to which the deposit is going to be directed
account
Account number with verification digit to which the deposit is going to be directed
account_operation
Either it's a savings account or a current account. current account
, saving account
document
Either the owner document or the company document for the account to which the deposit is going to be directed
beneficiary
Name of the owner of the account to which the deposit is going to be direct
pix
qrcode
String that contains the information of the qrcode. It is necessary to use some programming resource to convert this text into an image.
reference
String that contains the information of the copy and paste pix (pix copia e cola).
beneficiary
Name of the owner of the account to which the deposit is going to be direct
GET /v1/payment/{id}
Request
Response
Response details
id
The created payment by the request made unique identificator.
customer_id
The customer id stored on your platform for future identification.
transaction_id
The id of the transaction generated in you platform.
amount
The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)
currency
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.
status
The current status of the payment. These are our statuses: pending
, paid
, denied
, expired
method
The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.
created_at
The date and time the transaction was created.
updated_at
The date and time the transaction was updated with new status.
GET /v1/payments
Request
Parameters detail
limit
integer
min: 1 | max: 40
The number of items to return in the response.
page
integer
min: 1 | max: 9999999
The page number indicating which set of items will be returned in the response. So, the combination of page=1
and limit=20
returns the first 20 items. The combination of page=2
and limit=20
returns items 21 through 40.
sort
string
Format: item,(asc|desc)
Sorts the items in the response by filter in ascending or descending order.
Eg.: sort=id,desc
(This combination returns a list in descending order based on id.)
start_time
string
Internet date and time format
end_time
string
Internet date and time format
customer_id
string
min: 1 | max: 255
Sorts the items in the response by looking for the customer_id that was once provided by your system.
transaction_id
string
Sorts the items in the response by looking for the transaction_id that was once provided by your system.
To get multiple transaction_id, send each transaction_id separating by comma (,).
Eg.: 8fecdfcc-4e4d-11ee
,
8fece5ee-4e4d-11ee
,
d42953be-4e4d-11ee
Response
Response details
id
The created payment by the request made unique identificator.
customer_id
The customer id stored on your platform for future identification.
transaction_id
The id of the transaction generated in you platform.
amount
The amount that the client specified when initiating the transaction showed IN DOLLARS (use dot instead of comma)
currency
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.
status
The current status of the payment. These are our statuses: pending
, paid
, denied
, expired
payment_method
The payment method your customer will use. If bank_transfer is provided, we will return bank information for deposit, but if the provided is pix, the information for pix will be returned.
created_at
The date and time the transaction was created.
updated_at
The date and time the transaction was updated with new status.
Last updated