Skip to main content

Payouts via online banking in Brazil

To make account credits using online banking in Brazil, a request to the Tranzzo API must contain the following parameters:

pos_idUUIDMerchant's identifier (POS_ID)
methodMETHODPayment method (credit)
amountNumberTransaction amount
currencyCURRENCYTransaction currency (ISO_4217)
order_3ds_bypassString3-D Secure flow option
order_idStringUnique identifier of order
descriptionStringPayment description
server_urlURLWebhook notification will be sent to this URL
result_urlURLCustomer will be redirected to this URL after payment.
customer_fnameStringrecipient’s first name
customer_lnameStringrecipient’s last name
properties.document_idStringrecipient’s document ID
properties.document_typeStringrecipient’s document type
properties.bank_account_typeStringrecipient’s account type
properties.bank_accountStringrecipient’s account number
properties.bank_account_digitStringbank account digit
properties.bank_account_codeStringbank account code
properties.branch_codeStringbank regional code

The value of the payway parameter must be banking.

Validation: the properties.document_type parameter is optional for transaction creation (it can be used for informational purposes for you).

Request example:

"pos_id": "'$POS_ID'",
"mode": "direct",
"method": "credit",
"amount": 1,
"currency": "BRL",
"order_3ds_bypass": "supported",
"order_id": "'$ORDER_ID'",
"description": "Test description",
"payway": "banking",
"customer_lname": "Doe",
"customer_fname": "John",
"properties": {
"document_id": "0000000000",
"document_type": "CPF",
"bank_account_type": "CHECKING",
"bank_account": "12345678",
"bank_account_code": "260",
"branch_code": "0001"
"server_url": "",
"result_url": ""