Boletos
Call the Boletos API to request payments via banking billet (boleto bancário).
POST /v1/boleto
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
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.
address
address_1
string
min: 3 | max: 56
yes
The street name of the client address
number
string
min: 1 | max: 10
yes
The house/building number of the client address
address_2
string
min: 1 | max: 40
no
The address complement, such as, apartment number, commercial room number, etc...
neighborhood
string
min: 3 | max: 30
yes
The neighborhood name of the client address
city
string
min: 3 | max: 30
yes
The city name of the client address
state
string
min: 2 | max: 2
yes
The state name of the client address Allowed: AC,AL,AM,AP,BA,CE,DF,ES,GO,MA,MG,MS,MT,PA, PB,PE,PI,PR,RJ,RN,RO,RR,RS,SC,SE,SP,TO
postal_code
string
min: 8 | max: 8 Format: 99999999
yes
The postal code of the client address
id
status
The current status of the payment. These are our statuses: pending, paid, denied, expired
boleto
url
URL for the client to print the boleto that was generate
code
Code with which the client can pay the billet without printing
expired_at
Limit date to receive the payment for this billet
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
tax
The service fee value
Last updated