4. Informing the parameters

There are two different ways of providing the information required to process the payment: setting the data in the object used by each method or including specific attributes to HTML inputs in your checkout. Below we list the methods, their parameters and the equivalent attributes if you prefer to set the values using HTML inputs.

All methods return "this" to allow chaining of methods together.

4.1. setMerchant

Parameter	Attribute	Description	Required	Length

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
cc_authentication	-	Optional used when payment method is credit card (value 1 or 2). 1 = false 2 = true	No	1
cc_authentication_onfailure	-	Optional used when payment method is credit card (value 1 or 2). 1 = false 2 = true	No	1
homolog	PB_homolog	Required when connecting to the sandbox account (value “true“). See note “q“	No	4
merchant	-	Required when the payment method is Credit Card with Apple Pay.	No	Unlimited
wallet_type	-	Required when the payment method is a Credit Card with wallets. Use “AP” for Apple Pay or “GP” for Google Pay. Set this field as an array. (values: [“AP”, “GP”]) - See note "s"	No	2

4.2. setCustomer

Parameter	Attribute	Description	Required	Length

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

4.3. setOrder

Parameter	Attribute	Description	Required	Length

Parameter	Attribute	Description	Required	Length
order	PB_order	Order number. Used when executing the methods doAddOrder and doGetOrder. See note "f"	Yes	64
order_token	PB_order_token	Tokenized order number. Used only when executing the method doGetOrder.	No	80
product_name	PB_product_name	Product name. See note "g"	Yes	254
amount_brl	PB_amount_brl	Amount in Brazilian Real	Yes	7.2
param_url	PB_param_url	A string that can be included as a parameter in the PagBrasil.JS callback. It may contain any information the merchant wants to.	No	254

4.4. setPayment

Parameter	Attribute	Description	Required	Length

Parameter	Attribute	Description	Required	Length
payment_method	PB_payment_method	C = Credit card D = Débito Flash^™ B = Boleto Flash^® X = 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

4.5. setCard

Parameter	Attribute	Description	Required	Length

Parameter	Attribute	Description	Required	Length
cc_prevsaved	PB_cc_prevsaved	To be used when charging a previously saved credit card on subsequent purchases. See note "i"	No	80
cc_brand	PB_cc_brand	Credit card brand. See note "j"	No	1
cc_holder	PB_cc_holder	Credit card holder's name	Yes*	30
cc_number	PB_cc_number	Credit card number	Yes*	14 - 19
cc_expiration	PB_cc_expiration	Credit card expiration date. Format: MM/YY.	Yes*	5
cc_cvv	PB_cc_cvv	Card verification value (security code).	Yes*	3 - 4
wallet_type	PB_wallet_type	Used only when processing Samsung Pay transactions. See note "k"	No	2
wallet_payload	PB_wallet_payload	Used only when processing Samsung Pay transactions. See note "k"	No	Unlimited
soft_descriptor	PB_soft_descriptor	Text identification that will appear on the customer's credit card statement next to the payee name (PB). See note "l"	No	13
cc_save	PB_cc_save	Defines if the credit card information is stored at PagBrasil's server for future charges. This parameter must be always equal to "0" (zero) except when the customer has explicitly authorized future charges on their credit card. See note "m"	Yes	1
cc_auth	PB_cc_auth	Used only for credit card transactions. 0 = Authorize and capture 1 = Authorize only 2 = Capture a previously authorized transaction See note "n"	No	1

4.6. setOAuthToken

Value	Attribute	Description	Required	Length

Value	Attribute	Description	Required	Length
Token value as string	PB_oauth_token	OAuth token previously generated. See note "r"	Yes*	Unlimited

Notes:

a) All fields are required except when noted otherwise.

b) If a parameter is sent with a size greater than the maximum allowed, process will not be aborted but the value will be truncated.

c) You need to let the customer selects if they are a "pessoa física" (individual) or a "pessoa jurídica" (company). If they select "pessoa física", you need to ask for their full name and CPF (see note "b"). If they select "pessoa jurídica", you need to ask for the "razão social" (official company name registered at the local tax authority) and CNPJ (see note "b").

d) There are two types of tax IDs in Brazil: CPF (used by individuals, having 11 digits) and CNPJ (used by companies, having 14 digits). PagBrasil.JS will automatically remove the separators (e.g. "123.123.123-34" to "12312312334").

You must validate the tax ID to prevent sending to PagBrasil invalid values. You will find examples of CPF/CNPJ validation routines in different languages at the PagBrasil Dashboard, menu Resources.

For testing purposes, please use CPF 91051605962 and CNPJ 78797547000157.

e) The parameter address_state must be the official abbreviation used in Brazil. To prevent customer from entering an invalid state, please see table below to create a select object (drop-down list).

State	Abbreviation

State	Abbreviation
Acre	AC
Alagoas	AL
Amapá	AP
Amazonas	AM
Bahia	BA
Ceará	CE
Distrito Federal	DF
Espírito Santo	ES
Goias	GO
Maranhão	MA
Mato Grosso	MT
Mato Grosso do Sul	MS
Minas Gerais	MG
Pará	PA
Paraíba	PB
Paraná	PR
Pernambuco	PE
Piauí	PI
Rio de Janeiro	RJ
Rio Grande do Norte	RN
Rio Grande do Sul	RS
Rondônia	RO
Roraima	RR
Santa Catarina