Boleto

Introduction

Boleto is a payment method which allows to process payments in Brazilian reals and US dollars by using vouchers in Brazil. This method supports purchases.

This article provides information about working with the Boleto method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Interaction diagram

Payment processing by using the Boleto method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the Boleto service.

Operations support

Various platform interfaces can be used to process payments and perform operations using the Boleto method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links).

Processing scenarios

To perform a purchase by using the Boleto method, you need to redirect the customer to the Boleto service.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

General information

To process a purchase through Payment Page by using the Boleto method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Boleto method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when using the Boleto method:

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit
   • customer_id—customer identifier unique within the project
2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. The currency of payment can be BRL or USD.
4. Additionally, the following customer information should be specified:
   • customer_first_name and customer_last_name—first and last names of the customer
   • customer_email—customer email address
   • customer_address—customer post address
   • customer_zip—customer post code
   • identify_doc_number—number of the customer's identity document, should consist of 11 or 14 digits.
5. If you need to have the payment form displayed with the Boleto method selected, set the force_payment_method parameter to boleto.
6. Additionally, any other parameters available for working with Payment Page can be used (details).
7. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Boleto method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "BRL",
   "customer_id": "customer1",
   "customer_first_name": "Paul",
   "customer_last_name": "Marques",
   "customer_email": "customer@example.com",
   "customer_address": "Avenida das Nações",
   "customer_zip": "123456",
   "identify_doc_number": "84887177100",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "BRL",
   "customer_id": "customer1",
   "customer_first_name": "Paul",
   "customer_last_name": "Marques",
   "customer_email": "customer@example.com",
   "customer_address": "Avenida das Nações",
   "customer_zip": "123456",
   "identify_doc_number": "84887177100",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Boleto method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

Useful links

The following articles can be useful when implementing purchases via Payment Page:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a purchase through Gate by using the Boleto method, the merchant's web service is required to do the following:

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Receive an intermediate callback with the payment data and pass it to the customer as payment instructions or use it to redirect the customer to the Boleto service (depending on the payment processing provider).
3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Boleto method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Boleto method:

1. To initiate each purchase, send a separate POST request to the /v2/payment/voucher/boleto/sale endpoint. This endpoint belongs to the group /v2/payment/voucher/{payment_method}/sale.
2. Each request must include the following objects and parameters:
   • Object general—general purchase information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
   • Object payment—payment information:
     • amount—payment amount in the smallest currency unit
     • currency—payment currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
     • address—customer post address
     • zip—customer post code
     • Object identify—information about the document which establishes identity:
       • doc_number—number of the customer's identity document, should consist of 11 or 14 digits
   • Object return_url—URL for customer returning from the bank site:
     • success—site URL for redirection after a processed payment
3. The currency of payment can be BRL or USD.
4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Boleto method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, URL for redirection, as well as signature.

{
    "general": {
        "project_id": 580,
        "payment_id": "38202000002316",
        "signature": "h4ZxUifBNaLuvlYXyvBuqG/K0B9CjMCc2DbkDrk3qhLg=="
    },
    "payment": {
        "amount": 10000,
        "currency": "USD",
        "description": "38202000002316"
    },
    "customer": {
        "id": "589256",
        "email": "paul@mail.com",
        "first_name": "Paul",
        "last_name": "Marques",
        "address": "The street,23",
        "zip": "123456",
        "identify": {
            "doc_number": "84887177100"
        },
        "ip_address": "192.0.2.0"
    },
    "return_url": {
        "success": "example.com/success"
    }
}

{
    "general": {
        "project_id": 580,
        "payment_id": "38202000002316",
        "signature": "h4ZxUifBNaLuvlYXyvBuqG/K0B9CjMCc2DbkDrk3qhLg=="
    },
    "payment": {
        "amount": 10000,
        "currency": "USD",
        "description": "38202000002316"
    },
    "customer": {
        "id": "589256",
        "email": "paul@mail.com",
        "first_name": "Paul",
        "last_name": "Marques",
        "address": "The street,23",
        "zip": "123456",
        "identify": {
            "doc_number": "84887177100"
        },
        "ip_address": "192.0.2.0"
    },
    "return_url": {
        "success": "example.com/success"
    }
}

Formats of intermediate callbacks for customer redirection

Depending on the payment processing provider, it may be necessary to display instructions to customers or redirect them to the Boleto service. Information for displaying instructions and generating payment codes is contained in the callback from the payment platform in the provider_extra_fields object, so before displaying the instruction and generating codes, you must receive and process the callback:

• ticket_barcode—code for inclusion in the barcode
• ticket_company_name—payee company name
• ticket_expiration_date—expiry date and time of the voucher
• ticket_id—voucher identifier
• ticket_number—numeric voucher code
• ticket_provider_name—name of the bank that issues the voucher
• ticket_type—voucher type, can be numeric, barcode or custom
• image_url — URL of the full version of the voucher

"provider_extra_fields" : {
	"doc_number" : "1234567812",
	"ticket_barcode" : "1000010009136517000100040000626788",
	"ticket_company_name" : "BRASIL LTDA",
	"ticket_expiration_date" : "2019-06-20T08:13:39+00:00",
	"ticket_id" : "344.775",
	"ticket_number" : "104991365817006267884978590000001000",
	"ticket_provider_name" : "caixa",
       "ticket_type" : "NUMERIC",
	"image_url": "http://example.com/payments/e7fdb20-5ac7-8583-00971"
	}

To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

• body—object with data to be sent in the request body
• method—parameter specifying the HTTP method for sending the request (GET or POST)
• url—parameter containing a link for redirection

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Callback format

The Boleto method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 100,00 USD purchase made in the 842 project.

{
        "project_id": 842,
        "payment": {
            "id": "EP8a3e-3e96",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-03T12:09:38+0000",
            "method": "boleto",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": ""
        },
        "operation": {
            "id": 1001313740,
            "type": "sale",
            "status": "success",
            "date": "2019-06-03T12:09:38+0000",
            "created_date": "2019-06-03T12:08:52+0000",
            "request_id": "46b8b94eabf",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1414,
                "payment_id": "9d7e3e16b6a5",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "hTnUho5lgWxu+wgKzmhLdjawf5d8PwovSQGtyFSH7OBlJ8bQ=="
    }

The following is the example of a callback with information about a declined purchase.

 {
        "project_id": 842,
        "payment": {
            "id": "EP2ea6-f489",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-03T12:14:18+0000",
            "method": "boleto",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 2001313740,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-03T12:14:18+0000",
            "created_date": "2019-06-03T12:13:38+0000",
            "request_id": "d5978bf20bae024",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1414,
                "payment_id": "D-30006-7729dab9-3782-4c0a-8192-840622f63f08",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "eL+OigWVAgeT85JjOOUKYy+MkG9SCynp47KzdImN3tAy0kA=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.