Boleto Bancario
Boleto Bancario is a voucher-based payment method used in Brazil and it is supported by the Paysafe Payments API. There are several ways to pay for the voucher such as cash, online, and ATMs.
The Paysafe Payments API supports Boleto Bancario via SafetyPay as a Payment Instrument for iGaming and Crypto Merchants in Brazil. You can process Boleto Bancario online and cash payments using the Payments API.
Advantages:
-
Accepts payments from unbanked customers.
-
Boleto Bancario has no chargebacks risks.
-
Boleto expiration date, If Boleto is not paid in the appropriate time it expires and the transaction is cancelled.
-
One of the most popular payment methods in Brazil.
The Payments API caters to the following needs for Boleto Bancario:
- currencyCode: BRL
-
paymentType: BOLETO_BANCARIO
Setup Requirements
For Paysafe to create a test account in sandbox and production environments, the following information is required.
-
Paysafecard API key
Transaction Types
-
Payments
BRAZIL
| AMOUNT IN BRAZILIAN REAL | |
|---|---|
| Minimum Amount | Maximum Amount |
| R$3 | R$4,980 |
Note: The amount limits may vary in accordance with the currency exchange rate.
Payments Flow Diagram
Typical Scenarios
Boleto Bancario Payment
When you want to process a payment request using Boleto Bancario as the payment type, you would do the following:
-
Create a Payment Handle with the transactionType parameter set to PAYMENT and the paymentType parameter set to one of the following value: BOLETO_BANCARIO
-
Redirect the customer to the SafetyPay redirect URL so they can generate a payment code. The status of the Payment Handle becomes PAYABLE. The merchant gets notified of this status change via webhooks that have been configured.
-
Use the paymentHandleToken returned in the response to process the Payment request. The Payment will have a status of PROCESSING until the customer has made the payment.
Once the Payment is successfully completed by customer online, the merchant gets Payment Completed notification via webhooks.
API Contracts
Create a Payment Handle Example
{
"paymentType": "BOLETO_BANCARIO",
"boletoBancario": {
"consumerId": "merchantclientid5HzDvoZSodKDJ7X7VQ"
},
"transactionType": "PAYMENT",
"amount": 3000,
"currencyCode": "BRL",
"profile": {
"firstName": "ALBERTA",
"lastName": "BOBBETHCHARLESON",
"email": "accountholder0@example.com",
"phone": "1234567890",
"dateOfBirth": {
"day": 23,
"month": 12,
"year": 1990
}
},
"billingDetails": {
"nickName": "John Dee",
"street": "100",
"street2": "Queen Street",
"city": "Cupertino",
"zip": "14236",
"country": "US",
"state": "NY"
},
"merchantRefNum": "1653044860375",
"merchantDescriptor": {
"dynamicDescriptor": "Test Description",
"phone": "5555345456"
},
"shippingDetails": {
"recipientName": "Vishnu",
"street": "20735 Stevens Creek Blvd",
"street2": "Montessori",
"city": "Cupertino",
"zip": "95014",
"country": "US",
"state": "CA"
},
"dupCheck": false,
"deviceFingerprinting": {
"threatMetrixSessionId": "855d67c9-86dd-4b67-a036-72359bf5631a"
},
"returnLinks": [
{
"rel": "on_completed",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
"method": "GET"
},
{
"rel": "on_failed",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-error.html",
"method": "GET"
},
{
"rel": "default",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html",
"method": "GET"
}
]
}
Boleto Bancario Redirect URL to Generate a Payment Code Example
{
"id": "37c6e1ca-63e8-4c06-afbe-10e6f1883862",
"paymentType": "BOLETO_BANCARIO",
"paymentHandleToken": "PHyU59eJF7IWadmc",
"merchantRefNum": "1653044860375",
"currencyCode": "BRL",
"txnTime": "2022-08-19T08:22:30Z",
"billingDetails": {
"street": "100",
"street2": "Queen Street",
"city": "Cupertino",
"zip": "14236",
"state": "NY",
"country": "US"
},
"customerIp": "10.195.57.168",
"status": "INITIATED",
"links": [
{
"rel": "redirect_payment",
"href": "https://api.qa.paysafe.com/alternatepayments/v1/redirect?accountId=1020462050&paymentHandleId=37c6e1ca-63e8-4c06-afbe-10e6f1883862&token=eyJhbGciOiJIUzI1NiJ9.eyJhY2QiOiIxMDIwNDYyMDUwIiwicHlkIjoiMzdjNmUxY2EtNjNlOC00YzA2LWFmYmUtMTBlNmYxODgzODYyIiwiZXhwIjoxNjYwODk5MTUxfQ.qJkbunLS-eNuC_NQSSBJxEQorNj5nGKXwBy45tKbY4s"
}
],
"liveMode": false,
"simulator": "EXTERNAL",
"usage": "SINGLE_USE",
"action": "REDIRECT",
"executionMode": "ASYNCHRONOUS",
"amount": 3000,
"merchantDescriptor": {
"dynamicDescriptor": "Test Description",
"phone": "5555345456"
},
"timeToLiveSeconds": 599,
"gatewayResponse": {
"processor": "PAYSAFECARD",
"id": "pay_1020014923_NCriphH184shVLCd1Mth62H7Cx8unpnk_BRL"
},
"returnLinks": [
{
"rel": "on_completed",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html"
},
{
"rel": "default",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-success.html"
},
{
"rel": "on_failed",
"href": "https://api.dev.paysafe.com/checkout/v2/pages/redirect-error.html"
}
],
"transactionType": "PAYMENT",
"gatewayReconciliationId": "pay_1020014923_NCriphH184shVLCd1Mth62H7Cx8unpnk_BRL",
"updatedTime": "2022-08-19T08:22:31Z",
"statusTime": "2022-08-19T08:22:31Z",
"boletoBancario": {
"consumerId": "merchantclientid5HzDvoZSodKDJ7X7VQ"
},
"shippingDetails": {
"recipientName": "Vishnu",
"street": "20735 Stevens Creek Blvd",
"street2": "Montessori",
"city": "Cupertino",
"state": "CA",
"country": "US",
"zip": "95014"
},
"profile": {
"firstName": "ALBERTA",
"lastName": "BOBBETHCHARLESON",
"email": "accountholder0@example.com",
"dateOfBirth": {
"day": 23,
"month": 12,
"year": 1990
},
"phone": "1234567890"
}
}
Process Payment Request Using paymentHandleToken
{
"merchantRefNum": "1653044860375",
"amount": 3000,
"currencyCode": "BRL",
"dupCheck": true,
"settleWithAuth": true,
"paymentHandleToken": "PHyU59eJF7IWadmc",
"customerIp": "172.0.0.1",
"description": "Casino game purchase"
}
Payment Completed Notification via Webhooks
{
"id": "0d90aa92-ef05-4838-9295-ab636bb89b5c",
"paymentType": "BOLETO_BANCARIO",
"paymentHandleToken": "PHyU59eJF7IWadmc",
"merchantRefNum": "1653044860375",
"currencyCode": "BRL",
"settleWithAuth": true,
"dupCheck": false,
"txnTime": "2022-08-19T08:22:30Z",
"billingDetails": {
"street1": "100",
"street2": "Queen Street",
"city": "Cupertino",
"zip": "14236",
"state": "NY",
"country": "US"
},
"status": "PROCESSING",
"gatewayReconciliationId": "pay_1020014923_NCriphH184shVLCd1Mth62H7Cx8unpnk_BRL",
"amount": 3000,
"availableToRefund": 0,
"consumerIp": "10.195.57.168",
"liveMode": false,
"simulator": "EXTERNAL",
"updatedTime": "2022-08-19T08:23:04Z",
"statusTime": "2022-08-19T08:23:04Z",
"gatewayResponse": {
"processor": "PAYSAFECARD",
"id": "pay_1020014923_NCriphH184shVLCd1Mth62H7Cx8unpnk_BRL"
},
"availableToSettle": 0,
"boletoBancario": {
"consumerId": "merchantclientid5HzDvoZSodKDJ7X7VQ"
},
"shippingDetails": {
"recipientName": "Vishnu",
"street": "20735 Stevens Creek Blvd",
"street2": "Montessori",
"city": "Cupertino",
"state": "CA",
"country": "US",
"zip": "95014"
},
"profile": {
"firstName": "ALBERTA",
"lastName": "BOBBETHCHARLESON",
"email": "accountholder0@example.com",
"dateOfBirth": {
"day": 23,
"month": 12,
"year": 1990
},
"phone": "1234567890"
},
"settlements": {
"amount": 3000,
"txnTime": "2022-08-19T08:22:30.000+0000",
"availableToRefund": 0,
"merchantRefNum": "1653044860375",
"id": "0d90aa92-ef05-4838-9295-ab636bb89b5c",
"status": "RECEIVED"
}
}
To know more about each parameter, you can visit Payments.