Boleto Express

Introduction

Boleto Express is a payment method that allows customers to pay for their purchases using a boleto bancário. It is a popular payment method in Brazil, where it is used for a wide range of transactions, including utility bills, taxes, and online purchases.

Getting Started

• Generate Orders
• Get barcode and PDF

Generate Orders

Creating a Boleto Expresso TRANSPARENT order:

POST /api/v1/order
Host: latamgateway.com
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

{
  "customer": {
    "name": "Customer’s full name",
    "document": "111.222.333-44",
    "email": "[email protected]",
    "phone": "11999999999",
    "birth": "1996-03-09"
  },
  "order": {
    "code": "123",
    "notification_url": "your_payback_notification_url.com",
    "value": 50.00,
    "additional_info": "Some description of your order as String",
    "payment_method": "boleto_express"
  }
}

Params descriptions

Field	Description	Value Type	Required
customer.name	Customer's full name	String	Required
customer.document	Customer's document	String	Required
customer.email	Customer's email address	String	Required
customer.phone	Customer's phone number	String	Required
customer.birth	Customer's date of birth	String	Optional, but strongly recommended
order.code	Order reference in your system	String	Required
order.notification_url	URL to notify when status changes	String	Required
order.value	Total order value	Number (decimal)	Required
order.additional_info	Additional description of the order	String	Required
order.payment_method	Payment method	String	Required

On a successful request HTTP 200 status code, the response will include the following parameters:

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "code": "id_in_your_system",
  "confirmation_url": "https://latamgateway.com/7c0b8129-f556-4357-bb6e-8189c2943024", 
  "qrcode_link": "https://latamgateway.com/qrcode/7c0b8129-f556-4357-bb6e-8189c2943024" 
}

Business errors due to incorrect or missing parameters are returned with an HTTP 400 status code. The response will indicate which parameter is invalid or missing.

{
     "message": "Invalid document"
}

KYC errors are returned with an HTTP 403 status code. The response will contain the following parameters:

{
  "latam_id": "7c0b8129-f556-4357-bb6e-8189c2943024",
  "message": "kyc message table below",
  "code": "kyc code table below"
}

KYC RESPONSE CODES DESCRIPTIONS

Code	Message
KYC110	Invalid CPF, please verify your date of birth and CPF number.
KYC110	CPF document not found.
KYC110	CPF document belongs to a deceased holder. Year of death: 2024.
KYC110	CPF document is suspended.
KYC111	Invalid CNPJ, please verify your CNPJ number.
KYC112	Different name from the federal revenue register of natural persons.

Get barcode and PDF

To get Boleto bar code and PDF after generating the order:

GET /api/v1/qrcode/{latam_id}
Host: latamgateway.com
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

The response will include the following parameters:

GET /api/v1/qrcode/{latam_id}
Host: latamgateway.com
Content-Type: "application/json"
ACCOUNT_TOKEN: "<token>"

{
  "barcode": "A unique internal identifier assigned by the bank or issuer to track the boleto",
  "linhadigitavel": "The numbers that the customer can copy and paste into bank app",
  "pdf": "https://boleto.latamgateway.com/boleto/pdf/123"
}