Boleto

Overview

Boleto is a payment method that allows customers to perform purchases by using vouchers. Purchases are performed by using Payment Page and Gate.

General information

Payment method type Payments by using vouchers
Countries and regions Brazil
Payment currencies BRL, USD
Currency conversion
Purchases +
Payouts payout processing can be available depending on the payment processing provider, refer to your ECommPay key account manager for more information
COF-payments
Full refunds
Partial refunds
Chargebacks
Notes
  • depending on the payment processing provider, the validity period of the payment voucher can be one of the following:
    • 8 days, but a customer has 30 days to complete the payment by contacting the bank
    • 3 days
  • depending on the payment processing provider, payment amounts can be integer; refer to your ECommPay key account manager for more information
Onboarding and access fee Refer to your Key Account Manager ECommPay

Interaction diagram

Payment processing by using the Boleto payment method requires merchant's web service, one of the interfaces and the ECommPay payment platform, as well as provider's technical facilities and payment kiosks.



Operations support

  Interfaces Amounts
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Minimum Maximum
Purchases + + * *

* For the most recent amount limits, contact your ECommPay Key Account Manager.

Processing scenarios

In the Boleto method, a purchase operation is performed on Payment Page or in merchant web-service, where a customer provides the necessary information and than gets a voucher. The customer finishes the purchase operation by using the voucher in one of the available payment kiosks. Refunds are performed with the notification to a customer about the funds crediting to the bank account.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Boleto method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Boleto method selected. For more information about preselecting payment methods, see in Preselecting payment method.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Boleto method.
  8. The payment form is displayed to the customer corresponding to the request.
  9. The customer enters personal data.
  10. The payment platform receives the purchase request for payment processing.
  11. The payment platform performs the internal purchase request processing and sends it to the Boleto service.
  12. The purchase request is processed on the Boleto service side.
  13. The Boleto service generates a voucher for payment in kiosks or the redirection to the Boleto service data and send it to the payment platform. Depending on the payment processing provider, the validity period of the payment voucher can either be 8 days (but a customer has 30 days to complete the payment by contacting to the bank) or 3 days.
  14. The voucher or redirection data is sent to the Payment Page.
  15. The voucher and the instructions are displayed to the customer on Payment Page or on the Boleto side after redirection. The payment status awaiting customer action or awaiting redirect result (depending on the payment processing provider) remains until the customer completes the payment.
  16. The customer completes all the payment steps required in one of the payment kiosks using the received voucher.
  17. The payment is processed on the kiosks service side.
  18. The kiosks service sends the result notification to Boleto.
  19. The Boleto service sends the result notification to the payment platform.
  20. The payment platform sends a callback with the payment result to the web service.
  21. The customer receives the payment result from the web service.

The sections that follow discuss in more details of the request format and the Payment Page parameters to use in the Boleto payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

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

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units; depending on the payment processing provider, it may be necessary to specify an integer amount, refer to your ECommPay key account manager for more information
  2. Additionally, the following customer data should be passed:
    • customer_first_name and customer_last_name—first and last names
    • customer_email—email address
    • customer_address—post address
    • customer_zip—post code
    • identify_doc_number—number of the identity document, should content 11 or 14 digits.
  3. The currency of payment can be BRL or USD.
  4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.
  5. If you need to have payment form displayed with the Boleto method selected, set the force_payment_method parameter to boleto.
  6. If required, you can also add any other additional parameters Payment Page supports.

Thus, a correct payment request through the Boleto method must include project, customer, and payment IDs, customer data, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

Figure: Request example of Payment Page opening

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'BRL', 
      project_id: 0,    
      customer_id: '123',
      customer_first_name: 'Paul',
      customer_last_name: 'Marques',
      customer_email: 'paul@mail.com',
      customer_address: 'Avenida das Nações',
      customer_zip: '123456',
      identify_doc_number: '84887177100',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUk...=="
    }
)

For information about all parameters available in the Payment Page, see Payment Page invocation parameters.

Callback format

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

Here is an example of callback with an information about successful 100,00 USD purchase made by the customer in the 842 project.

Figure: Example of a successful purchase callback

{
        "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+wgKzmhLdjawVTrcq9KiR/u/xc3f53e5d8PwovSQGtyFSH7OBlJ8bQ=="
    }

Here is an example of callback for a denied purchase rejected due to inappropriate payment currency in the request.

Figure: Example of a declined purchase callback

 {
        "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+OigWVAgeT85JjOOUIkg5PyKCPYnwOE2o+T0lKYy+MkG9SCynp47KzdImN3tAy0kA=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Boleto methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Get the callback with the payment data and pass it to the customer as a payment instructions or the callback with the data to redirect the customer to the Boleto service (depending on the payment processing channel).
  3. Receive the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through the Boleto method on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Boleto service.
  7. The request is processed on the Boleto side.
  8. The Boleto service generates a voucher for payment in kiosks or the redirection to the Boleto service data and send it to the payment platform. Depending on the payment processing provider, the validity period of the payment voucher can either be 8 days (but a customer has 30 days to complete the payment by contacting to the bank) or 3 days.
  9. The voucher or redirection data is sent to the web service.
  10. The voucher and the instructions are displayed to the customer on Payment Page or on the Boleto site after redirection. The payment status awaiting customer action or awaiting redirect result (depending on the payment processing provider) remains until the customer completes the payment.
  11. The customer completes all the payment steps required in one of the payment kiosks using the received voucher.
  12. The payment is processed on the kiosks service side.
  13. The kiosks service sends the result notification to Boleto.
  14. The Boleto service sends the result notification to the payment platform.
  15. The payment platform sends a callback with the payment result to the web service.
  16. The customer receives the payment result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Boleto payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the Boleto method:
  1. You perform purchase by sending the /v2/payment/voucher/boleto/sale request by using POST (HTTP) method. This is payments by using vouchers request group: /v2/payment/voucher/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • email—email address
      • address—post address
      • zip—post code
      • Object identify—information about the document which establishes identity:
        • doc_number—number of the identity document, should consist of 11 or 14 digits
    • Object payment—purchase information:
      • amount—purchase amount in minor units; depending on the payment processing provider, it may be necessary to specify an integer amount, refer to your ECommPay key account manager for more information
      • currency—purchase currency in the ISO-4217 alpha-3 format
    • return_url—URL for customer returning from the bank site:
      • success—site URL for returning after performed payment
  3. The currency of payment can be BRL or USD.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Boleto method must include project and payment IDs, customer data, signature, currency and amount of the purchase, as shown in the following example:

Figure: Purchase request example

{
    general: {
        project_id: 580,
        payment_id: "38202000002316",
        signature: "h4ZxUifBNaLuvlYXyvBuqG/tRr67tWadwpXnBeF+iSR0K5OFdK0B9CjMCc2DbkDrk3qhLg=="
    },
    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: "66.249.64.45"
    },
    payment: {
        amount: 10000,
        currency: "USD",
        description: "38202000002316"
    }
}

Formats of the customer instructions data

Depending on the payment processing channel to complete the payment, you must display instructions to customers or or redirect them to the Boleto service. Information for creating a displayed instruction 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

To redirect a customer from the web service to the Boleto service, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following are the callback fragments containing the necessary data.

"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://site.com/payments/e7fdb20-5ac7-8583-0b690971"
		}
 "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://example.com/en/payments/pay/0a0ffa98-98da-11eed65"
                }

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 an information about successful 100,00 USD purchase made by a customer in the 842 project.

Figure: Example of a successful purchase callback

{
        "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+wgKzmhLdjawVTrcq9KiR/u/xc3f5d8PwovSQGtyFSH7OBlJ8bQ=="
    }

Here is an example of callback for a denied purchase rejected due to inappropriate payment currency in the request.

Figure: Example of a declined purchase callback

 {
        "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+OigWVAgeT85JjOOUIkg5PyKCPYnwOT0lKYy+MkG9SCynp47KzdImN3tAy0kA=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Boleto method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.