Skip to main content


To enable the Boleto payment method, you need to use direct integration. When creating a payment, send a request with the following parameters:

pos_idUUIDMerchant's identifier (POS_ID)
methodMETHODPayment method (purchase)
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_fnameStringpayer’s first name
customer_lnameStringpayer’s last name
customer_emailStringpayer’s email address
customer_phoneStringpayer’s phone number
properties.document_typeStringpayer’s document type
properties.document_idStringpayer’s document ID
properties.post_codeStringpayer’s postal code

Request example:

"pos_id": "'$POS_ID'",
"mode": "direct",
"amount": 5,
"method": "purchase",
"currency": "BRL",
"payway": "boleto",
"order_3ds_bypass": "supported",
"customer_lname": "Doe",
"customer_fname": "John",
"customer_email": "[email protected]",
"customer_phone": "1234567890",
"description": "Test description",
"order_id": "'$ORDER_ID'",
"properties": {
"document_id": "50284414727",
"document_type": "CNPJ",
"post_code": "88040-230"
"server_url": "",
"result_url": ""