Versions Compared

Key

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

...

Parameter

Attribute

Description

Required

Length

pbtoken

PB_pbtoken

Token assigned to your merchant account. Your token is displayed at the PagBrasil Dashboard, menu Account > Settings.

Yes

32

authentication

PB_authentication

Required when payment method is Débito Flash (value "3DS2").

No

4

authentication_onfailure

PB_authentication_onfailure

Required when payment method is Débito Flash (value "false").

No

5

homolog

PB_homolog

Required when connecting to the sandbox account (value “true“). See note “q“

No

4

4.2. setCustomer

Parameter

Attribute

Description

Required

Length

customer_name

PB_customer_name

Customer's full name if an individual, or "razão social" if the customer is a company. See note "c"   

Yes

128

customer_taxid

PB_customer_taxid

CPF if an individual, or CNPJ if the customer is a company. See note "d"   

Yes

14

customer_email

PB_customer_email

Customer's e-mail address

Yes

128

customer_phone

PB_customer_phone

Customer's phone number (including the 2-digit area code)

Yes

40

address_street

PB_address_street

Customer's street address

Yes

200

address_zip

PB_address_zip

Customer's postal code (in Brazil called CEP).

Only digits, do not include the dash.

Yes

8

address_city

PB_address_city

Customer's city

Yes

40

address_state

PB_address_state

Customer's state. See note "e"   

Yes

2

...

Parameter

Attribute

Description

Required

Length

payment_method

PB_payment_method

C = Credit card
D = Débito Flash
B = Boleto Flash®
X = PagBrasil Pix

Yes

1

bol_expiration

PB_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. You may extend the expiration date of an already issued boleto using the API function "/api/order/extend" (please refer to the Boleto Bancário documentation, item 7).

No

3.0

pec_expiration

PB_pec_expiration

Number of days (0 - 5) the PEC Flash® 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. You may extend the expiration date of an already issued PEC Flash® using the API function "/api/order/extend" (please refer to the PEC Flash® documentation, item 7).

No

3.0

cc_installments

PB_cc_installments

Number of installments. Required when payment method is credit (value "1" to "12") or Débito Flash (value "1"). See note "h"   

No

2

visitor_id

PB_visitor_id

Required when using PagShield fraud prevention service. Please refer to the PagShield documentation, available at the PagBrasil Dashboard, menu Resources.

No

40

...

Anchor
4.5.p
4.5.p
p) To emulate a successful payment, please refer to the documentation of each specific payment method available.

...

Anchor
4.5.q
4.5.q
q) To connect to the sandbox account, ensure to modify the setMerchant() method by adding the parameter "homolog": true. Please find the sample below.
Sandbox environment:

Code Block
$PB.setMerchant({
            "pbtoken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "homolog": true
        });

Production environment:

Code Block
$PB.setMerchant({
            "pbtoken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        });