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:

Parameter	Type	Required	Description
pos_id	UUID	✅	Merchant's identifier (POS_ID)
mode	MODE	✅	direct
method	METHOD	✅	Payment method (credit)
amount	Number	✅	Transaction amount. Must be a positive number. The number of decimal digits must be less than or equal to 2 (e.g., 100.00, 250, 50.50)
currency	CURRENCY	✅	Transaction currency (ISO_4217)
order_3ds_bypass	String	✅	3-D Secure flow option
order_id	String	✅	Unique identifier of order
description	String	✅	Payment description
payway	String	✅	banking
server_url	URL		Webhook notification will be sent to this URL
result_url	URL		Customer will be redirected to this URL after payment.
customer_fname	String	✅	recipient’s first name
customer_lname	String	✅	recipient’s last name
properties.document_id	String	✅	recipient’s document ID
properties.document_type	String		recipient’s document type
properties.bank_account_type	String	✅	recipient’s account type
properties.bank_account	String	✅	recipient’s account number
properties.bank_account_digit	String	✅	bank account digit
properties.bank_account_code	String	✅	bank account code
properties.branch_code	String	✅	bank 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_digit":"2",
        "bank_account_code": "260",
        "branch_code":       "0001"
    },
    "server_url":           "https://callback.blackhole.com/callback",
    "result_url":           "https://example.com/result"
}