Versions Compared

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

...