| Anchor | ||||
|---|---|---|---|---|
|
Your POST must be sent to https://sandbox.pagbrasil.com/api/order/add setting the content-type of the request header and body as "x-www-form-urlencoded".
Please note that this URL shall only be used for integration and testing procedures. Once the Payment Service Agreement is signed, you will receive the production environment's URL when you request your account to go live.
Request Parameters:
Field | Description | Required | Length |
|---|---|---|---|
secret | Secret phrase as defined in the PagBrasil Dashboard | Yes | 128 |
pbtoken | Token assigned to your merchant account. Your token is displayed at the PagBrasil Dashboard, menu Account > Settings. | Yes | 32 |
order | Order number. See note "d" | Yes | 64 |
payment_method | B = Boleto Bancário | Yes | 1 |
product_name | Product name. See Note "e" | Yes | 254 |
customer_name | Customer's full name if an individual, or "razão social" if the customer is a company. See note "f" | Yes | 128 |
customer_taxid | CPF if an individual, or CNPJ if the customer is a company. See note "g" | Yes | 14 |
customer_email | Customer's e-mail address | Yes | 128 |
customer_phone | Customer's phone number (including the 2-digit area code) | Yes | 40 |
address_street | Customer's street address | Yes | 200 |
address_zip | Customer's postal code (in Brazil called CEP). Only digits, do not include the dash. | Yes | 8 |
address_city | Customer's city | Yes | 40 |
address_state | Customer's state. See note "h" | Yes | 2 |
amount_brl | Amount in Brazilian Real | Yes | 5.2 |
bol_expiration | Number of days (0 - 999) the Boleto Bancário is valid for. If you don't use this parameter, our system will use the default value set at the PagBrasil Dashboard, menu Account > Settings.
| No | 3.0 |
param_url | A string that will be included in the XML with the list of the orders paid (See item 4.2). It may contain any information the merchant wants to. | No | 254 |
store_code | Code defined by the merchant per store to identify a set consisting of a customized message and a logo that will be displayed on each boleto. Shall not be used when the merchant has only one store associated to the supplied merchant account credentials (pbtoken and secret). | No | 32 |
Notes:
A) All fields are required except when noted otherwise.
...
State | Abbreviation |
|---|---|
Acre | AC |
Alagoas | AL |
Amapá | AP |
Amazonas | AM |
Bahia | BA |
Ceará | CE |
Distrito Federal | DF |
Espírito Santo | ES |
Goias | GO |
Maranhão | MA |
Mato Grosso | MT |
Mato Grosso do Sul | MS |
Minas Gerais | MG |
Pará | PA |
Paraíba | PB |
Paraná | PR |
Pernambuco | PE |
Piauí | PI |
Rio de Janeiro | RJ |
Rio Grande do Norte | RN |
Rio Grande do Sul | RS |
Rondônia | RO |
Roraima | RR |
Santa Catarina | SC |
São Paulo | SP |
Sergipe | SE |
Tocantins | TO |
...
| Anchor | ||||
|---|---|---|---|---|
|
You need to login to the PagBrasil Dashboard and specify the URL (webhook) you want PagBrasil to send the IPN (Instant Payment Notification) to with the list of Boletos Bancários paid.
...
Field | Description | Required | Length |
|---|---|---|---|
secret | Secret phrase as defined in the PagBrasil Dashboard. | Yes | 128 |
payment_method | Value "B". This value specifies that the data being posted is for paid boletos bancários (either for traditional Boletos Bancários or Boleto Flash®). | Yes | 1 |
content | XML as described. See note "c" | Yes | Unlimited |
signature | HMAC-MD5 hash that authenticates the parameter content. | Yes | 32 |
Notes:
| Anchor | ||||
|---|---|---|---|---|
|
...
In this example, the hash for the signature was computed using the concatenation of the parameter content and its total length (555) with the key "36d5f7184574caf84f5b48530ac0d690".
...
| Anchor | ||||
|---|---|---|---|---|
|
Boletos Bancários are processed in the next day after it was paid (until 10 AM – Brasília time zone).
...