Boleto Bancário Payments

Boleto Bancário is an e-commerce payment system used in Brazil that allows payers to purchase using either cash payments or via online banking payments. When the payer selects Boleto Bancário on the checkout page and proceeds with a cash payment, the payment details are displayed on screen and can be printed. The payer can then pay the amount required for the purchase at a Boleto Bacário location. For online banking payments, the payer enters the Boleto Bancário details, and reviews and authorises the payment. In both cases, once the payment is made, you will be notified and the goods may be released to be shipped to the payer.

Boleto Bancário is a supported browser payment method in the MasterCard Payment Gateway. This page describes integration details specific to Boleto Bancário. It's recommended that you read the integration guidelines for browser payments before building an Boleto Bancário integration.

Boleto Bancário browser payments are only supported for transactions in the USD currency.

Prerequisites

To offer Boleto Bancário as a payment method via the MasterCard Payment Gateway:

  • You must be registered with your browser payments service provider.
  • Your merchant profile on the gateway must be configured using the details of your account with the browser payments service provider.
  • You must have a bank account in one of the supported currencies registered against your merchant account at your browser payments service provider.

Boleto Bancário Integration

Boleto Bancário via Hosted Checkout

Boleto Bancário via Hosted Checkout will be available soon. Please contact your payment service provider for further information.

Boleto Bancário via Direct Payment

Direct Payment integration allows you to offer Boleto Bancário payment method on your own checkout page.

Boleto Bancário is supported from API version 50 onwards.

In addition to the standard fields required in a browser payment request, provide the following fields in the Initiate Browser Payment request:

  • sourceOfFunds.type = BOLETO_BANCARIO
  • browserPayment.operation = PAY (the Authorize operation is not supported by Boleto Bancário)
  • billing.address.*: Details of the payer's billing address.
  • customer.email: The email address of the payer.
  • customer.account.id: Your identifier for the payer's account with you.
  • customer.nationalId: An identifier for the payer assigned by a government authority.
  • sourceOfFunds.provided.boletoBancario.bankAccountHolder: The name of the bank account holder for the payer's bank account.

Preferred Language

You can set the language that you prefer Boleto Bancário to use for pages displayed to the payer by providing the browserPayment.preferredLanguage field in the Initiate Browser Payment request. However, the language will be used only if Boleto Bancário supports it.

Sample Code to Initiate Boleto Bancário Payment
{
  "apiOperation": "INITIATE_BROWSER_PAYMENT",
  "billing": {
    "address": {
      "street": "10 Upper Bank Street",
      "postcodeZip": "E14 5NP",
      "city": "London",
      "country": "GBR"
    }
  },
  "browserPayment": {
    "operation": "PAY",
    "returnUrl": "https://<return_url>"
  },
  "customer": {
    "email": "john.smith@example.com",
    "account": {
      "id": "1234567890"
    },
    "nationalId": "1234567890"
  },
  "order": {
    "amount": "10.00",
    "currency": "USD"
  },
  "sourceOfFunds": {
    "type": "BOLETO_BANCARIO",
    "provided": {
      "boletoBancario": {
        "bankAccountHolder": "John Smith"
      }
    }
  }
} 

How to Interpret the Transaction Result

The table below shows the transaction response codes for the possible scenarios you may encounter after initiating an Boleto Bancário payment.

Initiate Browser Payment Response What This Means...
response.gatewayCode=SUBMITTED
result=SUCCESS
Redirect the payer using the URL provided in the response.
Retrieve Transaction/Retrieve Order Response What This Means...
response.gatewayCode=APPROVED
result=SUCCESS
The payment is successful.
response.gatewayCode=PENDING
result=PENDING
The MasterCard Payment Gateway is waiting for a notification from the acquirer about the payment result. Try RETRIEVE_TRANSACTION again later or listen to notifications from the MasterCard Payment Gateway.
response.gatewayCode=CANCELLED
result=FAILURE
The payer has canceled the interaction for this payment. Offer the payer the option to try another payment method.
response.gatewayCode=DECLINED or ACQUIRER_SYSTEM_ERROR
result=FAILURE
The payment was declined. Offer the payer the option to try another payment method. In the case of an ACQUIRER_SYSTEM_ERROR you may want to inquire with the acquirer the reason for payment failure, or you can try RETRIEVE_TRANSACTION again.
response.gatewayCode=TIMED_OUT
result=FAILURE
Treat this as a declined payment. The MasterCard Payment Gateway will make an attempt to ensure the transaction is not successful or will revert the transaction.

Testing Your Integration

The MasterCard Payment Gateway provides a browser payments emulator that allows you to test your Boleto Bancário integration.

Copyright © 2021 MasterCard