Online banking in Brazil

To enable online banking in Brazil, you need to use direct integration. When creating a payment, send a request with the following parameters:

Parameter	Type	Required	Description
pos_id	UUID	✅	Merchant's identifier (POS_ID)
mode	MODE	✅	direct
method	METHOD	✅	Payment method (purchase)
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	✅	payer’s first name
customer_lname	String	✅	payer’s last name
customer_email	String	✅	payer’s email address
customer_ip	String	✅	payer’s IP
properties.trusted	Boolean	✅	whether the trusted payer
properties.instrument_type	String	✅	instrument type (online_banking)
properties.instrument_method	String	✅	instrument method alias
properties.bank_code	String	✅	payer’s regional bank code
properties.branch_code	String	✅	payer’s bank branch code
properties.bank_account_type	String	✅	payer’s bank account type
properties.account_number	String	✅	payer’s bank account number
properties.document_id	String	✅	payer’s document number
properties.document_type	String	✅	payer’s document type

Request example:

{
    "pos_id":           "00000000-0000-0000-0000-000000000000",
    "mode":             "direct",
    "amount":           1,
    "method":           "purchase",
    "currency":         "BRL",
    "payway":           "banking",
    "customer_lname":   "Doe",
    "customer_fname":   "John",
    "order_3ds_bypass": "supported",
    "customer_email":   "[email protected]",
    "properties": {
        "instrument_type":    "online_banking",
        "instrument_method":  "BANK_BRAZIL",
        "bank_code":          "143",
        "branch_code":        "0001",
        "bank_account_type":  "S",
        "account_number":     "00112233445566",
        "document_id":        "00000000001",
        "document_type":      "CPF"
    },
    "description": "      Description",
    "order_id":           "1234567890",
    "server_url":         "http://callback-stub:9000/consume",
    "result_url":         "https://google.com"
}