...
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 | D = Débito Flash™ | Yes | 1 |
product_name | Product name. See note "e" | Yes | 254 |
products | JSON structure with the list of products or service in the subscription. See note “m“ | Yes | Unlimited |
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 | 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 "i" | Yes | 2 |
amount_brl | Amount in Brazilian Real | Yes | 7.2 |
cc_installments | Required to be set as 1. | Yes | 1 |
cc_holder | Debit card holder's name | Yes | 30 |
cc_number | Debit card number. For length See note "j" | Yes | 14-19 |
cc_expiration | Debit card expiration date. Format: MM/YY. | Yes | 5 |
cc_cvv | Card Verification Value (security code). This field is optional as some debit cards don't have a CVV on the back of the card. Please make sure this field isn't mandatory (for debit cards only). | Yes | 3 |
soft_descriptor | Text identification that will appear on the customer's bank account statement next to the payee name (PB). See note "h" | No | 13 |
param_url | A string that can be concatenated to the URL our server posts the response to. See note "l" | No | 254 |
auth3ds_type | Authentication field obtained using PagBrasil.JS method getAuth3DS. | Yes | 32 |
auth3ds_cavv | Authentication field obtained using PagBrasil.JS method getAuth3DS. | Yes | 254 |
auth3ds_version | Authentication field obtained using PagBrasil.JS method getAuth3DS. | Yes | 1 |
auth3ds_eci | Authentication field obtained using PagBrasil.JS method getAuth3DS. | Yes | 2 |
auth3ds_reference_id | Authentication field obtained using PagBrasil.JS method getAuth3DS. | Yes | 36 |
auth3ds_xid | Authentication field obtained using PagBrasil.JS method getAuth3DS. | Yes | 254 |
...
l) The URL our server posts the response to for an "/api/order/add" call consists of a fixed and a dynamic part. The first part is defined at the PagBrasil Dashboard, menu Account > Settings. The second part is defined using param_url (optional). For example, if you define at the PagBrasil Dashboard the URL as
"https://www.test.com/script.asp"
and param_url as "?customer_id=12345&newsletter=yes"
we will post the authorization response to:
"https://www.test.com/script.asp?customer_id=12345&newsletter=yes"
...
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block |
|---|
{ “sku“: “productSKU“,“amount“:0.00,“quantity“:0,“discount“:0 } |
4.2. Receiving the IPN with the authorization response
...
Field | Description | Length |
|---|---|---|
secret | Secret phrase as defined in the PagBrasil Dashboard | 128 |
payment_method | D = Debit card | 1 |
order | Order number | 64 |
amount_brl | Amount in Brazilian Real | 7.2 |
payment_status | A = Authorized | 1 |
error_code | Used when order_status equal to PF. See table in item 7. | 2 |
signature | HMAC-MD5 hash that authenticates the IPN. | 32 |
Notes:
a) After processing our IPN your server needs to acknowledge it has successfully received it by writing "Received successfully [timestamp]". If your server responds to our IPN with an invalid acknowledgement, our system will e-mail your technical contact a warning notification (subject "Urgent: Error posting IPN - Not Compliant"). In this case, the IPN will not be resent and you may want to resend the IPN manually at the PagBrasil Dashboard, menu IPN History, after resolving the problem at your end.
...