Versions Compared

Old Version 7

changes.mady.by.user PagBrasil

Saved on

compared with

New Version Current

changes.mady.by.user PagBrasil

Saved on

Key

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

...

Tokenize the credit card information previously defined with setCard. You only need to use this method if you want to store a tokenized credit card to charge it in a future moment.

Tokenization is disabled by default. If you want to use it for recurring payments or other business models, please contact PagBrasil for further information.

Required methods:

  • setMerchant (see item 4.1).

...

Parameter

Description

Length

order

Order number

64

order_token

Tokenized order number

80

payment_method

C = Credit card
D = Débito Flash™
B = Boleto Bancário
F = Boleto Flash®
P = PEC Flash®
X = PagBrasil Pix

1

submission_date

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

10

url_boleto

URL to view/print the Boleto Bancário. Only available when payment_method equal to "B" or "F".

80

url_payment

URL that redirects the customer to the bank's page to complete the payment. Only available when payment_method equal to "R", "E", "U" or "S".

80

company_code

Company code. Only available when payment_method equal to "P".

10

payment_id

Payment identification. Only available when payment_method equal to "P".

17

payment_instructions

Payment instructions in Portuguese. Only available when payment_method equal to "P".

254

expiration_date

Last date to pay the PagBrasil Pix.
Format: MM/DD/YYYY.
Only available when payment_method equal to "X".

10

expiration_time

Maximum time within the expiration date the PagBrasil Pix will be allowed to be paid.
Format: HH:MM.
Only available when payment_method equal to "X"

5

pix_image

Pix QR Code image link.
Only available when payment_method equal to "X"

80

pix_code

Alternative code for mobile users to complete the payment when they cannot scan the code (QR Code payload data).
Only available when payment_method equal to "X"

254

order_status

WP = Payment requested but not processed yet
PA = Payment pre-authorized but not captured yet
PC = Payment Completed
PF = Payment Failed
PR = Payment Rejected
RR = Refund Requested
RP = Refund Processed
CB = Chargeback

2

authorization_code

Authorization code provided by the card issuer. Only available when payment_method equal to "C" or "D" and order has been authorized.

9

payment_date

Date the payment was completed.
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 (including the 2-digit area code)

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

Amount paid by the customer in Brazilian Real

7.2

cc_installments

Number of installments (1 to 12). Only available when payment_method equal to "C" or "D".

2

cc_brand

Card brand. Only available when payment_method equal to "C" or "D". See note "j"   

1

cc_holder

Card holder's name. Only available when payment_method equal to "C" or "D".

30

cc_number

Card number truncated. Only available when payment_method equal to "C" or "D".

14 - 19

soft_descriptor

Text identification that will appear on the customer's credit card statement next to the payee name (PB). Only available when payment_method equal to "C" or "D".

13

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.2, note "c".

128

error_code

Used when order_status equal to PF or PR, and payment_method equal to "C" or "D". See table in item 7.

2

...

Parameter

Description

Length

order

Order number

64

order_token

Tokenized order number

80

payment_method

C = Credit card
D = Débito Flash™
B = Boleto Bancário
F = Boleto Flash®
P = PEC Flash®
X = PagBrasil Pix

1

submission_date

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

10

url_boleto

URL to view/print the Boleto Bancário. Only available when payment_method equal to "B" or "F".

80

url_payment

URL that redirects the customer to the bank's page to complete the payment. Only available when payment_method equal to "R", "E", "U" or "S".

80

company_code

Company code. Only available when payment_method equal to "P".

10

payment_id

Payment identification. Only available when payment_method equal to "P".

17

payment_instructions

Payment instructions in Portuguese. Only available when payment_method equal to "P".

254

expiration_date

Last date to pay the PagBrasil Pix.
Format: MM/DD/YYYY.
Only available when payment_method equal to "X".

10

expiration_time

Maximum time within the expiration date the PagBrasil Pix will be allowed to be paid.
Format: HH:MM.
Only available when payment_method equal to "X"

5

pix_image

Pix QR Code image link.
Only available when payment_method equal to "X"

80

pix_code

Alternative code for mobile users to complete the payment when they cannot scan the code (QR Code payload data).
Only available when payment_method equal to "X"

254

order_status

WP = Payment requested but not processed yet
PA = Payment pre-authorized but not captured yet
PC = Payment Completed
PF = Payment Failed
PR = Payment Rejected
RR = Refund Requested
RP = Refund Processed
CB = Chargeback

2

authorization_code

Authorization code provided by the card issuer. Only available when payment_method equal to "C" or "D" and order has been authorized.

9

payment_date

Date the payment was completed.
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 (including the 2-digit area code)

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

Amount paid by the customer in Brazilian Real

7.2

cc_installments

Number of installments (1 to 12). Only available when payment_method equal to "C" or "D".

2

cc_brand

Card brand. Only available when payment_method equal to "C" or "D". See note "j"   

1

cc_holder

Card holder's name. Only available when payment_method equal to "C" or "D".

30

cc_number

Card number truncated. Only available when payment_method equal to "C" or "D".

14 - 19

soft_descriptor

Text identification that will appear on the customer's credit card statement next to the payee name (PB). Only available when payment_method equal to "C" or "D".

13

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.2, note "c".

128

error_code

Used when order_status equal to PF or PR, and payment_method equal to "C" or "D". See table in item 7.

2

...