Brazil Online Banking

Overview

Introduction

Brazil Online Banking is a payment method which allows you to process payments in Brazilian reals and US dollars by using bank accounts in Brazil. This method supports purchases and refunds.

This article provides information about working with the Brazil Online Banking 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

Payment method type bank payments
Payment instruments bank accounts
Countries and regions BR
Payment currencies BRL, USD
Currency conversion on the ecommpay side
One-time purchases +
Credential-on-file purchases –
Full refunds +
Partial refunds +
Payouts –
Chargebacks –
Notes full or partial refunds can be issued within 90 calendar days after the purchase
Onboarding and access fee refer to your ecommpay account manager

Interaction diagram

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



Operations support

Various platform interfaces can be used to process payments and perform operations using the Brazil Online Banking method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

The following properties and limitations apply to the Brazil Online Banking method.

Amounts ¹ Times ²
minimum maximum base threshold
Purchases * * 3 minutes 36 hours
Refunds * * 5 minutes 36 hours
Note:
  1. Minimum and maximum payment amounts depend on the banks that the customer can select after redirection to the provider service. The bank will not be available for selection if the payment amount is outside the limits set by the bank.
  2. The base and threshold times are defined as follows:
    • The base 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 web service. The base 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 the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase by using the Brazil Online Banking method, you need to redirect the customer to the provider service, while to make a refund, you need to receive a request from the customer and notify the customer about the result of the refund via the web service.

Figure 1. Purchase by using Payment Page


Figure 2. Purchase by using Gate


Figure 3. Refund by using Gate


Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the Brazil Online Banking 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.

Figure 4. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Brazil Online Banking method.
  8. The payment platform receives the request for processing the payment by using the Brazil Online Banking method.
  9. The payment platform processes the request and sends it to the provider service.
  10. The request is processed on the provider service side.
  11. The data for redirecting the customer to the provider service is sent from the provider service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the provider service.
  14. The customer completes all required payment steps on the provider service side.
  15. The purchase is processed in the provider service.
  16. The result information is displayed to the customer in the provider service.
  17. The customer is redirected to Payment Page.
  18. The provider service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the Brazil Online Banking 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 sending purchase requests by using the Brazil Online Banking 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. Additionally, it is required to specify the following parameters:
    • customer_first_name—first name of the customer
    • customer_last_name—last name of the customer
    • customer_email—customer email address
    • identify_doc_number—number of the CPF (Brazilian tax identification number of customer), must contain 11 digits, to be specified without masked characters, spaces, or other separators

    To avoid errors during payment processing it is recommended to set the value length of 3 to 100 characters in the parameters customer_first_name and customer_last_name.

  4. If you need to have the payment form displayed with the Brazil Online Banking method selected, set the force_payment_method parameter to online-brazil-banks.
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Brazil Online Banking method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature, as well as possible additional parameters.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "customer_email": "johndoe@example.com",
   "identify_doc_number": "12345678901",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 5. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "customer_email": "johndoe@example.com",
   "identify_doc_number": "12345678901",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Brazil Online Banking method uses the standard format for callbacks to deliver purchase results. For more information, see Handling callbacks (details).

The following is the example of a callback with information about a 100.00 USD purchase made by the 1 customer in the 123456 project.

Figure 6. Example of callback data indicating that the purchase has been processed
{
        "project_id": 123456,
        "payment": {
            "id": "24113462",
            "type": "purchase",
            "status": "success",
            "date": "2025-04-28T12:35:34+0000",
            "method": "brazil",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "Test sale TEST_PAYMENT_280425_1"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 3096000012631,
            "type": "sale",
            "status": "success",
            "date": "2025-04-28T12:35:34+0000",
            "created_date": "2025-04-28T12:20:31+0000",
            "request_id": "10ebdff5fbed43c68bf9a123911551da98eb071c-00003097",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 21463,
                "payment_id": "140347770236",
                "auth_code": ""
            }
        },
        "signature": "vZ8+G9mQFv1lfth8yxvoqn/PmpHnKhIw+5XaZ/xfTIf6Kl+WjRkHKXE29nw=="
    }
}

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

Figure 7. Example of callback data indicating that the purchase has been declined
{
        "customer": {
            "id": "1"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_398957",
            "type": "purchase",
            "status": "decline",
            "date": "2025-04-21T01:15:28+0000",
            "method": "brazil",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "TEST_PAYMENT_398957"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1139,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 16353,
                "payment_id": "140347102975",
                "auth_code": ""
            },
            "id": 5031180010141499,
            "type": "sale",
            "status": "decline",
            "date": "2025-04-21T01:15:28+0000",
            "created_date": "2025-04-14T12:15:04+0000",
            "request_id": "a57b332905b8b07d9f0442268d404145e6153584-197b9b48dcbf85651b13318f699befb1e501a90a-05031181"
        },
        "signature": "XvIAwMNq/nDzn28ZwuIN8QmuR57NqP2r8RD1ZYsCusvS4jF7XJd7YX9D0LQSly5kKquIdamW2Xzu4uS4v9PnLw=="
    }
}

Useful links

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

Purchases by using Gate

General information

To process a purchase through Gate by using the Brazil Online Banking 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 from the payment platform and redirect the customer to the provider service.
  3. Receive the final callback from the payment platform.

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



Figure 8. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the Brazil Online Banking method in the web service.
  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.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The request is processed on the provider service side.
  8. The provider service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the provider service.
  11. The customer completes all required payment steps on the provider service side.
  12. The purchase is processed in the provider service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the Brazil Online Banking 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 Brazil Online Banking method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/banks/brazil/sale endpoint. This endpoint belongs to the group /v2/payment/banks/{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
  3. Additionally, it is required to specify the following objects and parameters:
    • Object customer—customer information:
      • first_name— customer first name (to avoid errors during payment processing it is recommended to set the following value length—from 3 to 100 characters)
      • last_name—customer last name (to avoid errors during payment processing it is recommended to set the following value length—from 3 to 100 characters)
      • email—customer email address
      • identify—information about the document which establishes identity:
        • doc_number—number of the CPF (Brazilian tax identification number of customer), must contain 11 digits, to be specified without masked characters, spaces, or other separators.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Brazil Online Banking method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, signature, as well as possible additional parameters.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "USD"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@example.com",
        "identify": {
            "doc_number": "12345678901"
     }
  }
}
Figure 9. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 10000,
    "currency": "USD"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@example.com",
        "identify": {
            "doc_number": "12345678901"
     }
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the Brazil Online Banking method requires redirection of customers from the merchant's web service to the provider service. 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
Figure 10. redirect_data example
  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Final callback format

The Brazil Online Banking method uses the standard format for callbacks to deliver purchase results. For more information, see Handling callbacks (details).

The following is the example of a callback with information about a 100.00 USD purchase made by the 1 customer in the 123456 project.

Figure 11. Example of callback data indicating that the purchase has been processed
{
        "project_id": 123456,
        "payment": {
            "id": "24113462",
            "type": "purchase",
            "status": "success",
            "date": "2025-04-28T12:35:34+0000",
            "method": "brazil",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "Test sale TEST_PAYMENT_280425_1"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 3096000012631,
            "type": "sale",
            "status": "success",
            "date": "2025-04-28T12:35:34+0000",
            "created_date": "2025-04-28T12:20:31+0000",
            "request_id": "10ebdff5fbed43c68bf9a123911551da98eb071c-3c6a0ba271207cb817a0c683cf36e7a33ff2d9b4-00003097",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 21463,
                "payment_id": "140347770236",
                "auth_code": ""
            }
        },
        "signature": "vZ8+G9mQFv1lfth8yxvoqn15Q0dM2S+iD5RNQvCeMsG/PmpHnKhIw+5XaZ+Fsd6z/xfTIf6Kl+WjRkHKXE29nw=="
    }
}

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

Figure 12. Example of callback data indicating that the purchase has been declined
{
        "customer": {
            "id": "1"
        },
        "project_id": 59051,
        "payment": {
            "id": "TEST_PAYMENT_398957",
            "type": "purchase",
            "status": "decline",
            "date": "2025-04-21T01:15:28+0000",
            "method": "brazil",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "TEST_PAYMENT_398957"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1139,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 16353,
                "payment_id": "140347102975",
                "auth_code": ""
            },
            "id": 5031180010141499,
            "type": "sale",
            "status": "decline",
            "date": "2025-04-21T01:15:28+0000",
            "created_date": "2025-04-14T12:15:04+0000",
            "request_id": "a57b332905b8b07d9f0442268d404145e6153584-197b9b48dcbf85651b13318f699befb1e501a90a-05031181"
        },
        "signature": "XvIAwMNq/nDzn28ZwuIN8QmuR57NqP2r8RD1ZYsCusvS4jF7XJd7YX9D0LQSly5kKquIdamW2Xzu4uS4v9PnLw=="
    }
}

Useful links

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

Refunds by using Gate

General information

To perform a refund through Gate by using the Brazil Online Banking method, 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 refund performing are provided below.



Figure 13. Refund performing by using Gate: step-by-step description
  1. A customer initiates a refund.
  2. The web service sends the request for performing the refund by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The refund is processed on the side of the provider service.
  8. The provider service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the refund result information from the web service.

Information about the formats of requests and callbacks used for performing refunds by using the Brazil Online Banking 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 refund requests by using the Brazil Online Banking method:

  1. To initiate each refund, send a separate POST request to the /v2/payment/refund endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general refund information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—identifier of the payment that needs to be refundedpayment identifier
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—refund information:
      • description—refund description or comment
      • amount—refund amount in the smallest currency unit (required for a partial refund)
      • currency—refund currency code in the ISO-4217 alpha-3 format (required for a partial refund)
    • Object customer—customer information:
      • ip_address—customer IP address relevant for the initiated refund
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct refund request by using the Brazil Online Banking method must contain the project and payment identifiers, description of the refund, the customer IP address, signature, and, if necessary, currency code and refund amount.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 10000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}
Figure 14. Example of sufficient data in a refund request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 10000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Callback format

The Brazil Online Banking method uses the standard format for callbacks to deliver refund results. For more information, see Handling callbacks.

The following is the example of a callback with information about a 100.00 USD full refund made by the 1 customer in the 433772 project.

Figure 15. Example of callback data indicating that the refund has been processed
{
     "project_id": 433772,
    "payment": {
        "id": "TEST_PAYMENT_265608",
        "type": "purchase",
        "status": "refunded",
        "date": "2025-06-26T06:48:37+0000",
        "method": "brazil",
        "sum": {
            "amount": 0,
            "currency": "USD"
        },
        "description": "TEST_PAYMENT_265608"
    },
    "customer": {
        "id": "1"
    },
    "operation": {
        "id": 7373000014760,
        "type": "refund",
        "status": "success",
        "date": "2025-06-26T06:48:37+0000",
        "created_date": "2025-06-26T06:48:34+0000",
        "request_id": "ad3982700e2b1db7038c7fada82ab9c85e4071f0-8e341c2093149beae0f501759402e5753c7d7f2c-00007374",
        "sum_initial": {
            "amount": 10000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "USD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1903,
            "payment_id": "1750920516487",
            "auth_code": ""
        }
    },
    "signature": "GpBmChC6jOdrdA7Shl5UBhX1Soj+efRx//eCni5FFx+9Fa7KTqa1y6zQfZu7hXeEB19vWtEOuCr2L/VFmkQ3DQ=="
}

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

Figure 16. Example of callback data indicating that the refund has been declined
{
    "project_id": 433772,
    "payment": {
        "id": "test_29.04.25_3",
        "type": "purchase",
        "status": "partially refunded",
        "date": "2024-12-29T11:36:34+0000",
        "method": "brazil",
        "sum": {
            "amount": 90000,
            "currency": "BRL"
        },
        "description": "test_29.04.25_3"
    },
    "customer": {
        "id": "1"
    },
    "operation": {
        "id": 5557000012956,
        "type": "refund",
        "status": "decline",
        "date": "2024-12-29T11:22:44+0000",
        "created_date": "2024-12-29T11:22:44+0000",
        "request_id": "c717b3de84d1ba574598a637f856a-00002267",
        "sum_initial": {
            "amount": 50000,
            "currency": "BRL"
        },
        "sum_converted": {
            "amount": 8994,
            "currency": "USD"
        },
        "code": "3283",
        "message": "Refund amount more than init amount",
        "provider": {
            "id": 21514,
            "payment_id": "1418092457",
            "auth_code": ""
        }
    },
    "signature": "PWoXcLWZbWyySxLSpFq3TC04YQt1WFgSocteIUw=="
}

Useful links

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

Refunds by using Dashboard

When working with Dashboard, you can perform single and mass refunds by using the Brazil Online Banking method.

  • To perform a single refund, select the target purchase, open its information tab, specify the amount of the refund, send a request and verify that the refund has been performed.

  • To perform a mass refund, prepare and upload a file with information about all target refunds, send a batch request, and verify that the refunds have been performed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The refund parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information Information about performing refunds by using Dashboard is presented in a separate section.

Analysis of payments results

To analyse information about payments made with the Brazil Online Banking method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.