Bank Transfer
Call the Payments API to request payments via Bank Transfer.
POST /v2/payin
Request
Parameters details
customer.id
string
yes
Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer
customer.name
string
yes
The full name of the customer making the payment. It should match the name on the customer's identification documents
customer.email
string
yes
The email address of the customer. This will be used for sending payment confirmations and notifications
customer.phone
string
(E.164)
no
customer.birthdate
string
no
The birthdate of the customer, provided in the format mm-dd-yyyy
. This parameter may be required depending on the country regulations or the payment method
customer.document.number
string
Format: 99999999999 / 9999999999999
yes
The official identification number of the customer. This is typically a national ID, or other government-issued document
customer.document.type
string
(CPF or CNPJ)
yes
customer.address.addres_1
string
no
The primary street address of the customer
customer.address.addres_2
string
no
Additional address information, such as apartment number or suite
customer.address.city
string
no
The city in which the customer resides
customer.address.country_code
string
no
customer.address.neightborhood
string
no
The neighborhood or district of the customer's address
customer.address.number
string
no
The street number of the address
customer.address.postal_code
string
no
The postal or ZIP code for the customer's address
customer.address.state
string
no
The state or region of the customer's address
transaction.id
string
yes
A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process
transaction.currency
string
(BRL or USD)
yes
transaction.amount
decimal
(10,2)
yes
The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma)
Eg: 300.10
transaction.expire
integer (11)
no
The time in seconds until the transaction expires and is no longer valid
branch
string
min: 1 | max: 255
no
The specific branch or location identifier where the transaction is being processed, if applicable
country
string
yes
payment_method
string
yes
The method of payment being used for the transaction, such as bank transfer, credit card...
notification_url
string
yes
The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format
Response
Response details following the link: overview
Last updated