Accept Boleto payments in your online store.

Boleto Bancário, commonly known as Boleto, is a payment method used in Brazil. It allows customers to pay for goods and services by generating a bank slip, which can be paid at a bank, post office, or online banking. Boleto is popular among customers who do not have a credit card or prefer to pay with cash. Use the emerchantpay  API to accept Boleto as a payment method across the supported emerchantpay’s payment integrations.
Payment method Countries/regions
Cash-based Brazil


1. Create a Boleto payment request

To submit a payment using Boleto, create a payment request to the emerchantpay Genesis payment gateway. Specify boleto as the transaction_type.

Example of passing a Boleto transaction request:

 <?xml version=”1.0″ encoding=”UTF-8″?>
<usage>40208 concert tickets</usage>
<address1>14, Nerazdelni str</address1>
<city>Rio de Janeiro</city>

2. Receive a response

You will receive a Success or Error response to your payment request.

Example of a Success response:

<?xml version=”1.0″ encoding=”UTF-8″?>
<technical_message>Transaction successful!</technical_message>
<message>Transaction successful!</message>
<descriptor>Descriptor one</descriptor>

Asynchronous notification

Because the Boleto payment transaction is asynchronous, the result of your customer’s payment is sent as a separate HTTP POST notification from the gateway to the notification_url that you supplied with the transaction request.

Example of a notification for a Boleto transaction:
“transaction_id”: “f44f2856b5d933c04f42d1e922e30cbf”
“terminal_token”: “871bbbd2f9ce1d58dead9848ef5a24ab59a8ee94”
“unique_id”: “832eb553eba838f79113167cbc1002a1”
“transaction_type”: “boleto”
“status”: “approved”
“signature”: “b74ed54d95589fce6f9d7a229b225fd4a925e9bc”
“amount”: “1200”
“funds_status”: “NOT_EXPECTED”
“account_holder”: “John Smith”
“bank_account_number”: “NL18ABNA0484869868”
“bank_identifier_code”: “ABNANL2A”

Use the signature field to verify that the notification has been sent by the Genesis gateway. Each session signature is generated by combining the unique_id of the transaction and your API password, and generating a SHA-1 hash function of the combined string.

signature = SHA-1 hash value of <unique_id><API password>

Notification signature examples:
unique_id API password signature
26aa150ee68b1b2d6758a0e6c44fce4c 50fd87e65eb415f42fb5af4c9cf497662e00b785 c5219b3d385e74496b2b48a549
3f760162ef57a829011e5e2379b3fa17 50fd87e65eb415f42fb5af4c9cf497662e00b785 14519d0db2f7f8f407efccc9b099

After you have verified the notification state and validity, render an XML page containing the transaction’s unique id to acknowledge that you have received the notification.

Example of a notification reply you use to confirm a notification:
<?xml version=”1.0″ encoding=”UTF-8″?>

3. Test your integration

Before you can accept live payments, you must test your integration in the emerchantpay staging environment.

  1. Add an item to your cart in your online store.
  2. Proceed to the checkout page and check out using Boleto.
  3. Follow the redirect link in the response.
  4. In the payment simulator, follow the instructions to simulate a transaction.
  5. Complete the order and verify that you are redirected to the order confirmation page.
  6. Log in to Genesis.
  7. In the navigation menu, go to Payment transactions.
  8. Verify that the transaction appears at the top of the list and is successful.

4. Accept live payments

After you have successfully tested your Boleto integration, you are ready to move to the production environment and accept live payments. Contact your emerchantpay Account Manager to get your login credentials for the Genesis production environment.

You are now ready to accept live payments using Boleto.