Versions Compared

Version Old Version 11 New Version Current
Changes made by

PagBrasil

PagBrasil

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Description

Length

order

Order number

64

payment_method

X = PagBrasil Pix

1

submission_date

Date the order was submitted to PagBrasil.
Format: MM/DD/YYYY.

10

expiration_date

Last date to pay the PagBrasil Pix.
Format: MM/DD/YYYY.

10

expiration_time

Maximum time within the expiration date the PagBrasil Pix will be allowed to be paid.
Format: HH:MM.

5

pix_image

Pix QR Code image link.

80

pix_code

Alternative code for mobile users to complete the payment when they cannot scan the code (QR Code payload data).

254

order_status

WP = Waiting for Payment
PC = Payment Completed
PR = Payment Rejected. See note "b"   
RR = Refund Requested
RP = Refund Processed
CB = Chargeback

2

authorization_code

Authorization code provided by the bank. Only available when order has been authorized.

32

payment_date

Used when order_status equal to PC, RR or RP.
Format: MM/DD/YYYY.

10

product_name

Product name

254

customer_name

Customer's name

128

customer_taxid

CPF if an individual, or CNPJ if the customer is a company

14

customer_email

Customer's e-mail address

128

customer_phone

Customer's phone number

40

address_street

Customer's street address

200

address_zip

Customer's postal code (in Brazil called CEP)

8

address_city

Customer's city

40

address_state

Customer's state (official abbreviation)

2

amount_brl

Amount in Brazilian Real

7.2

amount_paid

Used when order_status equal to PC, RR or RP. Amount paid by the customer in Brazilian Real – may not be the exact amount due, so it must be validated and treated according your policy.

7.2

amount_refunded

Used when order_status equal to RR or RP. Amount requested to be refunded (Brazilian Real).

7.2

refund_date

Used when order_status equal to RP.
Date the refund requested was completed.
Format: MM/DD/YYYY.

10

refund_info

Used when order_status equal to RR or RP.
See item 6.1, note "b".

128

signature

HMAC-MD5 hash that authenticates the response. See note "a"   

32

...

Code Block
languagexml
<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
<order>1234567890</order>
<payment_method>X</payment_method>
<submission_date>10/12/2010</submission_date>
<expiration_date>10/12/2010</expiration_date>
<expiration_time>23:59</expiration_time>
<pix_image>https://pagbrasil.com/x/img?i174bwzjqc</pix_image>
<pix_code>9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999</pix_code>
<order_status>PC</order_status>
<authorization_code>E19999999999999999999s9999a9e99f</authorization_code>
<payment_date>10/15/2010</payment_date>
<product_name>Product Test (1 license)</product_name>
<customer_name>José da Silva</customer_name>
<customer_taxid>91051605962</customer_taxid>
<customer_email>josedasilva@myemail.com.br</customer_email>
<customer_phone>11 3328.9999</customer_phone>
<address_street>Av.Paulista, 100</address_street>
<address_zip>01311100</address_zip>
<address_city>São Paulo</address_city>
<address_state>SP</address_state>
<amount_brl>39.50</amount_brl>
<amount_paid>39.50</amount_paid>
<signature>f04312f1f4ed9adae484af97ac95de8a<<signature>df25f0641026b821058de166fe63c448</signature>
</request>

In this example, the hash for the signature was computed using the following string with the key "36d5f7184574caf84f5b48530ac0d690":

Code Block
1234567890X10/12/201010/12/201023:59https://pagbrasil.com/x/img?i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999PC10i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999PCE19999999999999999999s9999a9e99f10/15/2010Product Test (1 license)José da Silva91051605962josedasilva@myemail.com.br11 3328.9999Av.Paulista, 10001311100São PauloSP39.5039.5038050412

Please note that the "380412" at the end of the string is the length of the concatenated values of the XML elements:

Code Block
1234567890X10/12/201010/12/201023:59https://pagbrasil.com/x/img?i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999PC10i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999PCE19999999999999999999s9999a9e99f10/15/2010Product Test (1 license)José da Silva91051605962josedasilva@myemail.com.br11 3328.9999Av.Paulista, 10001311100São PauloSP39.5039.50

...

Code Block
languagexml
<?xml version="1.0" encoding="ISO-8859-1"?>
<request>
<order>1234567890</order>
<payment_method>X</payment_method>
<submission_date>10/12/2010</submission_date>
<expiration_date>10/12/2010</expiration_date>
<expiration_time>23:59</expiration_time>
<pix_image>https://pagbrasil.com/x/img?i174bwzjqc</pix_image>
<pix_code>9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999</pix_code>
<order_status>RP</order_status>
<authorization_code>E19999999999999999999s9999a9e99f</authorization_code>
<payment_date>10/15/2010</payment_date>
<product_name>Product Test (1 license)</product_name>
<customer_name>José da Silva</customer_name>
<customer_taxid>91051605962</customer_taxid>
<customer_email>josedasilva@myemail.com.br</customer_email>
<customer_phone>11 3328.9999</customer_phone>
<address_street>Av.Paulista, 100</address_street>
<address_zip>01311100</address_zip>
<address_city>São Paulo</address_city>
<address_state>SP</address_state>
<amount_brl>39.50</amount_brl>
<amount_refunded>39.50</amount_refunded>
<refund_date>10/30/2010</refund_date>
<refund_info>Banco 001 - Agência 1234 - Conta 12345678-0</refund_info>
<signature>47d01185413b303af5f3c5fa0bb7d6cf<<signature>19fca7aca0b0a9a8376045f68b7cd7db</signature>
</request>

In this example, the hash for the signature was computed using the following string with the key "36d5f7184574caf84f5b48530ac0d690":

Code Block
1234567890X10/12/201010/12/201023:59https://pagbrasil.com/x/img?i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999RP10i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999RPE19999999999999999999s9999a9e99f10/15/2010Product Test (1 license)José da Silva91051605962josedasilva@myemail.com.br11 3328.9999Av.Paulista, 10001311100São PauloSP39.5039.5010/30/2010Banco 001 - Agência 1234 - Conta 12345678-04330465

Please note that the "433465" at the end of the string is the length of the concatenated values of the XML elements:

Code Block
1234567890X10/12/201010/12/201023:59https://pagbrasil.com/x/img?i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999RP10i174bwzjqc9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999RPE19999999999999999999s9999a9e99f10/15/2010Product Test (1 license)José da Silva91051605962josedasilva@myemail.com.br11 3328.9999Av.Paulista, 10001311100São PauloSP39.5039.5010/30/2010Banco 001 - Agência 1234 - Conta 12345678-0

...