Skip to content

Binance Pay

Introduction

Binance Pay is a payment method that allows customers to pay for their orders using their Binance Pay account. To know more about Binance Pay, please visit Binance Pay.

Getting Started

Generate Orders

Creating a Binance Pay 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": "binance_pay"
  }
}

Params descriptions

Field Description Value Type Requirement
customer.name Customer's full name String Required
customer.document Customer's document String Required (see notes below)
customer.email Customer's email address String Required
customer.phone Customer's phone number String Required
customer.birth Customer's date of birth String Required
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

Note 1: The document can be a valid CPF or CNPJ. If CNPJ is used, the company name must be passed in the name parameter.

Note 2: CPF and CNPJ are the Brazilian individual and company identification numbers, respectively.

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

{
    "latam_id": "c0c4ab1e-a03a-4104-98f2-2183d8b828f2",
    "code": "id_in_your_system",
    "confirmation_url": "https://latamgateway.com/binance_pay/finish/c0c4ab1e-a03a-4104-98f2-2183d8b428f2",
    "qrcode_link": "https://latamgateway.com/api/v1/qrcode/c0c4ab1e-a13a-4104-98f2-2183d8b828f2"
}

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 QR code and Image

To get QR Code info and image after generating the order:

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

The response will contain the following parameters:

{
 "deep_link": "deeplink to open binance app",
 "qrcode_link": "link to qrcode image jpg",
 "universal_link": "universal url to open binance",
 "qrcode_image": "base64 of the image"
}