Cash and online banking payments in Brazil

Overview

Cash and online banking payments in Brazil is a payment method that customers to pay by using online banking and cash in Brazil. You can perform purchases through this method by using Payment Page and Gate, as well as refunds by using Gate and Dashboard.

General information

Payment method type	bank payments point of sale payments
Payment instruments	cash bank accounts
Countries and regions	BR
Payment currencies	USD
Currency conversion	–
Purchases	+
Payouts	–
Stored credentials payments	–
Full refunds	+
Partial refunds	+
Chargebacks	–
Special considerations	refunds are only available for online banking purchases
Obtaining access to the payment method and access fee	refer to your ecommpay key account manager

Interaction diagram

Payment processing by using the Cash and online banking payments in Brazil payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as provider's technical facilities.

Operations support

	Interfaces				Amounts		Times*
	Payment Page	CMS Plug-ins	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases	+	–	+	–	–	equivalent of 46,000.00 BRL in USD	–	35 hours
Full refunds	–	–	+	+	–	–	–	–
Partial refunds	–	–	+	+	–		–	–

** The basic and threshold times are defined as follows:

The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.

Processing scenarios

In the Cash and online banking payments in Brazil method, to perform a purchase operation, you need to redirect customer to the provider service, while to initiate a refund you need to receive a request from a customer.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Figure: Refund 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 Cash and online banking payments in Brazil method, when processing 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 the Cash and online banking payments in Brazil method selected. For more information about preselecting payment methods, see in Preselecting payment methods. The full sequence and particularities of the purchase process are provided below.

Figure: Purchase by using Payment Page

A customer initiates a purchase on the merchant's web service.
The web service sends the request for Payment Page opening to the specified ecommpay URL.
The request for opening is redirected to the payment platform.
The payment platform performs the initial request processing that involves validation of the required parameters and signature.
Requested Payment Page is generated into the ecommpay payment platform as specified in the project settings and the request parameters.
Payment Page is displayed to the customer.
The customer selects the Cash and online banking payments in Brazil method.
The payment platform receives the purchase request for payment processing from Payment Page.
The payment platform performs the internal purchase request processing and sends it to the provider service.
The purchase request is processed on the provider service side.
The provider service generates the data for redirecting the customer to its website form and sends it to the payment platform.
The payment platform sends the customer redirection data to Payment Page.
The customer is redirected to the provider website.
The customer completes all the payment steps required.
The payment is processed on the provider side.
The result is displayed to the customer on the provider website.
The customer is redirected to Payment Page.
The provider service sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
The payment platform sends the result to Payment Page.
A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Cash and online banking payments in Brazil 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 Cash and online banking payments in Brazil method:

You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
- project_id—the project ID obtained from ecommpay
- payment_id—payment ID unique within the project
- payment_currency—currency code in ISO-4217 alpha-3 format
- payment_amount—integer payment amount in minor units
- customer_id—the unique ID of the customer within your project
It is recommended to specify the following parameters:
- customer_last_name—last name of the customer (to avoid errors during payment processing it is recommended to set the following value length—from 3 to 100 characters)
- identify_doc_number—number of the document which establishes identity, must consist of 11 or 14 digits.
If the request is missing the parameters, on Payment Page the additional fields are displayed to the customer to input missing data. For more details about clarification, see Submission of additional payment information.
The currency of payment can only be USD.
If you need to have payment form displayed with the Cash and online banking payments in Brazil method selected, set the force_payment_method parameter to online-brazil-banks.
If required, you can also add any other additional parameters Payment Page supports.
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.

Thus, a correct payment request in the Cash and online banking payments in Brazil method must include project, customer and payment IDs, customer information, currency code and the amount of a payment, as well as signature, as shown in the following example:

    { payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'USD',
      customer_id: 'customer1', 
      customer_last_name: 'Johnson',
      identify_doc_number: '12345678901',
      project_id: 123, 
      signature: "kUi2x9dKHAVNU0FYldJRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the Cash and online banking payments in Brazil method, see Parameters for opening payment form.

Callback format

The Cash and online banking payments in Brazil 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 10.00 USD purchase made in the 239 project.

Figure: Example of data in a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "brazil",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "brazil",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

Purchase by using Gate

General information

In the Cash and online banking payments in Brazil method, when processing a purchase by using Gate, the merchant web service is required to do the following:

Send a request with all the required parameters and signature to the ecommpay URL.
Perform the redirection of a customer to the provider service.
Get the callback with the payment result from the payment platform.

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

Figure: Purchase by using Gate

A customer initiates a purchase through Cash and online banking payments in Brazil on the merchant's web service side.
The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
The payment platform receives the request for processing the purchase from Gate.
The payment platform performs the initial request processing that includes validation of the required parameters and signature.
The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
The payment platform performs the internal payment request processing and redirects the request to the provider service.
The request is processed on the provider side.
The provider service sends the data for redirecting the customer to the provider service to the payment platform.
The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
The customer is redirected from the web service to the provider service.
The customer completes all the payment steps required.
The payment is processed on the provider side.
The result is displayed to the customer.
The customer is redirected to the merchant's web service.
The provider service sends the payment result notification to the payment platform.
The payment platform sends a callback to the web service.
The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Cash and online banking payments in Brazil payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Cash and online banking payments in Brazil method:

You perform purchases by sending the /v2/payment/banks/brazil/sale request by using POST (HTTP) method. This is the online-banking payments request group: /v2/payment/banks/{payment_method}/sale.
The following objects and parameters must be specified in any request:
- Object general—general request identification information:
  - project_id—the project ID obtained from ecommpay
  - payment_id—payment ID unique within the project
  - signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
- Object payment—payment information:
  - amount—integer payment amount in minor units
  - currency—currency code in ISO-4217 alpha-3 format
- Object customer—customer information:
  - id—the unique ID of the customer within your project
  - ip_address—customer IP address
  - last_name—last name (to avoid errors during payment processing it is recommended to set the following value length—from 3 to 100 characters)
  - Object identify—information about the document which establishes identity:
    - doc_number—number of the identity document, must consist of 11 or 14 digits
- Object return_url—contains the URLs to which customer is redirected while or after payment processing:
  - return—URL to return customer to the web service during any step before the payment is completed
The currency of purchase can only be USD.
If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Cash and online banking payments in Brazil method must include project, customer and payment IDs, currency code and amount of the purchase, as well as signature, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
      "project_id": 211,
      "payment_id": "payment_id",
      "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "USD"
    },
    "customer": {
      "last_name": "Johnson",
      "id": "123",
      "ip_address": "1.1.1.1",
      "identify": {
            "doc_number": "84887177100"
        },
    },
    "return_url": {
      "return": "http://example.com/return"
    }  
}

Formats of the customer redirection data

To redirect a customer from the web service to the Cash and online banking payments in Brazil site, 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 is the callback fragment containing the redirection data.

    "redirect_data": {
        "body": {...},
        "method": "GET",
        "url": "http://example.test/"
    }

Callback format

The Cash and online banking payments in Brazil 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 10.00 USD purchase made in the 239 project.

Figure: Example of data in a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "brazil",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "brazil",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

Refunds by using Gate

General information

Cash and online banking payments in Brazil full and partial refunds processing by using Gate: merchant's web service sends a request with all the required parameters and signature to the ecommpay URL, and receives a callback with the payment result. The full sequence of the refund process is provided below.

Figure: Refund sequence when using Gate

A customer orders a refund by using the web service.
Merchant's web service sends the request for the refund processing by using Gate to the appropriate ecommpay URL.
Gate redirects the request to the ecommpay payment platform.
The payment platform performs all the necessary checks and processes the request.
The response with the request processing results is sent to the merchant's web service. For more information, see Response format.
The payment platform redirects the refund request to the Cash and online banking payments in Brazil service.
The payment is processed on the Cash and online banking payments in Brazil side.
Cash and online banking payments in Brazil sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
The customer receives the information about the receipt of the requested funds from the web service

The sections that follow discuss in more details the request format and the Gate parameters to use in the Cash and online banking payments in Brazil payment method and provide the information on the format of callbacks with refund results.

Request format

There are several things you must consider when using refund requests in the Cash and online banking payments in Brazil method:

You perform purchases by sending the /v2/payment/banks/brazil/refund request by using POST (HTTP) method. This is the online-banking payments request group: /v2/payment/banks/{payment_method}/sale.
The following objects and parameters must be specified in any request:
- Object general—general refund information:
  - project_id—the project ID obtained from ecommpay
  - payment_id—payment ID unique within the project
  - 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:
  - ip_address—IP address
- Object payment—refund information:
  - description—comment or description
  - amount—refund amount in minor units (mandatory for partial refunds only)
  - currency—refund currency in ISO-4217 alpha-3 format (mandatory for partial refunds only)
If required, you can also add any other additional parameters Gate supports.

Thus, a correct partial refund request in the Cash and online banking payments in Brazil method must include project and payment IDs, signature, currency and amount of the refund, refund description and customer IP address, as shown in the following example:

Figure: Example of a partial refund request

  "general": {    
    "project_id": 211,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSKpFBR4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO56lCv+f1M0Sf/7eg=="
  },
  "payment": {    
    "amount": 1000,    
    "currency": "USD",
    "description": "refund"
  },
   "customer": {    
     "ip_address": "1.1.1.1"
  }

Callback format

The Cash and online banking payments in Brazil method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 10.00 USD refund in the 442 project.

Figure: Example of a successful refund callback

{
        "project_id": 442,
        "payment": {
            "id": "1234",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-12-13T08:19:43+0000",
            "method": "brazil",
            "sum": {
                "amount": 0,
                "currency": "USD"
            },
            "description": ""
        },
        "customer": {
            "id": "67881"
        },
        "operation": {
            "id": 1000000011,
            "type": "refund",
            "status": "success",
            "date": "2020-12-13T08:19:43+0000",
            "created_date": "2020-12-13T08:19:38+0000",
            "request_id": "3a97fd62a7ad166700adcde96c21831b005a7d5c329cbc3c16e",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "provider": {
                "id": 1284,
                "payment_id": "105115311",
                "date": "2020-12-13T08:19:41+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "kpghwSQiaUa8+cX2vHbgmbT...6o2uQgLTqDvQtCMGGHHJpUqPc4CGzungYw=="
    }

The following is the example of a callback for a refund declined as the amount in the refund requested is greater than the amount in the initial payment.

Figure: Example of a declined refund callback

{
        "project_id": 442,
        "payment": {
            "id": "1234566",
            "type": "purchase",
            "status": "success",
            "date": "2020-12-13T08:18:43+0000",
            "method": "brazil",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": ""
        },
        "customer": {
            "id": "67881"
        },
        "operation": {
            "id": 1000000011,
            "type": "refund",
            "status": "decline",
            "date": "2020-12-13T08:19:43+0000",
            "created_date": "2020-12-13T08:18:44+0000",
            "request_id": "3a97fd62a7ad166700adcde96c2c3c16e",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "provider": {
                "id": 1169,
                "payment_id": "105887607",
                "date": "2020-02-19T14:25:24+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "kpghwSQiaUa8+cX2vHbgmbT...6o2uQgLTqDvQtCMGGHHJpUqPc4C4324gYw=="
    }

Analysis of payments results

As with other payment methods ecommpay offers, when using the Cash and online banking payments in Brazil 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 in the Analytics section for this purpose.

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 format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
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 means of sending requests to the /operations/get endpoint.

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

Cash and online banking payments in Brazil

Overview

General information

Interaction diagram

Operations support

Processing scenarios

Purchase by using Payment Page

General information

Request format

Callback format

Related topics

Purchase by using Gate

General information

Request format

Formats of the customer redirection data

Callback format

Related topics

Refunds by using Gate

General information

Request format

Callback format

Related topics

Analysis of payments results