2. Class mapping

Classes that must be mapped in your HTML code.

Once the class is mapped to it's given field, the script is able to retrieve the value contained in the field and submit it to compose the authentication request.

⚠️
Warning

The higher amount of fields parametrized, the higher is the chance of having a authentication without challenge, since the issuer will have more data for the risk analysis.

The # character indicated in the field must be replaced by the number representing the item index. Example: bpmpi_item_1_productName' represents the first item of the cart.

ℹ️
Required field for Amex
Amex requires the parameterization of bpmpi_brand_establishment_code in Merchant Defined Data.

Access and Authentication Type

Field	Description	Type/Size	Required
`bpmpi_auth`	Boolean indicating whether or not the transaction is submitted to the authentication process.	Boolean: true - submit to authentication false - don't submit to authentication	Yes
`bpmpi_auth_notifyonly`	Boolean indicating whether the card transaction will be submitted in "notification only" mode. In this mode, the authentication process will not be triggered, however, the data will be submitted to the flag. Valid only for Mastercard and Visa	Boolean: true - Data Only mode; false - authentication mode	Not required if 3DS Full / Required if 3DS Data Only
`bpmpi_auth_suppresschallenge`	Boolean that indicates if ignore or not the challenge. If the challenge is ignored, the liability will keep with the merchant.	Boolean: true – ignore challenge false – perform challenge	Recommended
`bpmpi_accesstoken`	Token generated by Access Token API (step 1)	Alphanumeric (variable)	Yes

Order

Field	Description	Type/Size	Required
`bpmpi_ordernumber`	Merchant order number	Alphanumeric must be mapped in	Yes
`bpmpi_currency`	Currency code	Fixed "BRL"	Yes
`bpmpi_totalamount`	Total transaction amount (cents)	Numeric that must be mappe	Yes
`bpmpi_installments`	Number of Installments	Numeric that must be mapp	Yes
`bpmpi_paymentmethod`	Card type to be authenticated. If the card has both functions, it is necessary to specify the transaction type.	Credit - Credit Card Debit - Debit Card	Yes
`bpmpi_cardnumber`	Card number	Numeric that must be mappe	Yes
`bpmpi_cardexpirationmonth`	Card expiration month	Numeric that must be mapp	Yes
`bpmpi_cardexpirationyear`	Card expiration year	Numeric that must be mapp	Yes
`bpmpi_cardalias`	Card alias	Alphanumeric must be mapped in y	Recommended if there is a card alias.
`bpmpi_default_card`	Indicates whether it is a standard customer card in the e-commerce	Boolean true - yes false - no	Recommended
`bpmpi_recurring_enddate`	End date of recurrency	Text (AAAA-MM-DD)	Recommended, if recurrent transaction
`bpmpi_recurring_frequency`	Frequency of recurrency	Number 1 - Monthly 2 - Bimonthly 3 - Quarterly 4 - Four Monthly 6 - Semester 12 - Annual	Recommended, if recurrent transaction
`bpmpi_recurring_originalpurchasedate`	Date of first transaction that originated the recurrency	Text (AAAA-MM-DD)	Recommended, if recurrent transaction

Order description

Field	Description	Type/Size	Required
`bpmpi_order_recurrence`	Indicates whether it is an order that generates future recurrences	Boolean (true or false)	Recommended, if recurrent transaction
`bpmpi_order_productcode`	Product Type	PHY: purchase goods CHA*: Check acceptance ACF*: Account financing QCT*: Quasi-Cash Transaction PAL**: Prepaid Activation and Load	Yes
`bpmpi_order_countlast24hours`	Number of orders placed by same customer in the last 24 hours	Numeric that must be mapp	No
`bpmpi_order_countlast6months`	Number of orders placed by same customer in the last 6 months	Numeric that must be mapp	Recommended
`bpmpi_order_countlast1year`	Number of orders placed by same customer in the last year	Numeric that must be mapp	Recommended
`bpmpi_order_cardattemptslast24hours`	Number of orders placed with the same card in the last 24 hours	Numeric that must be mapp	Recommended
`bpmpi_order_marketingoptin`	Indicates whether the shopper accepted to receive marketing offers	Boolean true - yes false - no	Recommended
`bpmpi_order_marketingsource`	Identifies the origin of the marketing campaign	Alphanumeric must be mapped in	Recommended
`bpmpi_transaction_mode`	Identifies the channel from which the transaction originates	M: MOTO R: Retail S: E-Commerce P: Mobile T: Tablet	Recommended
`bpmpi_merchant_url`	Address of the e-commerce's web site	Alphanumeric must be mapped in y Example: `https://www.example.com.br`	Yes

ℹ️
To use 3DS authentication in a sandbox environment, use "https://localhost" on the bpmpi_merchant_url field.

Prepaid cards

Field	Description	Type/Size	Required
`bpmpi_giftcard_amount`	The total purchase amount for prepaid gift cards in rounded value	Numeric [max 15 positions]. Example: R$125,54 = 12554	Recommended if the card being used is prepaid
`bpmpi_giftcard_currency`	Transaction currency code paid with prepaid type card	Fixed "BRL"	Recommended if the card being used is prepaid

Billing address

Field	Description	Type/Size	Required
`bpmpi_billto_customerid`	Identifies the CPF/CNPJ of customer	Numeric that must be mapped 99999999999999	No
`bpmpi_billto_contactname`	Billing address contact name	Alphanumeric must be mapped in y	Recommended
`bpmpi_billto_phonenumber`	Billing address phone number	Numeric that must be mappe, in the format: 5511999999999	Recommended
`bpmpi_billto_email`	Billing address contact email	Alphanumeric must be mapped in y, in the format `[email protected]`	Recommended
`bpmpi_billto_street1`	Street address and billing address number	Alphanumeric must be mapped in	Recommended
`bpmpi_billto_street2`	Neighborhood and complement billing address	Alphanumeric must be mapped in	Recommended
`bpmpi_billto_city`	Billing address city	Alphanumeric must be mapped in	Recommended
`bpmpi_billto_state`	Billing address state. Brazil, United States, and Canada: enter the state abbreviation of the billing address. Other countries**: enter the country abbreviation for billing.	Text es that must	Recommended
`bpmpi_billto_zipcode`	Billing address zip code	Alphanumeric must be mapped in, in the format: 99999999	Recommended
`bpmpi_billto_country`	Billing address country	Text es that must e.g., BR	Recommended

Delivery address

Field	Description	Type/Size	Required
`bpmpi_shipto_sameasbillto`	Indicates it is the same address provided on the billing address	Boolean (true or false)	Recommended
`bpmpi_shipto_addressee`	Shipping address contact name	Alphanumeric must be mapped in	Recommended
`bpmpi_shipTo_phonenumber`	Delivery address phone number	Numeric that must be mappe, in the format: 5511999999999	Recommended
`bpmpi_shipTo_email`	Delivery address contact email	Alphanumeric must be mapped in y, in the format `[email protected]`	Recommended
`bpmpi_shipTo_street1`	Street address and delivery address number	Alphanumeric must be mapped in	Recommended
`bpmpi_shipTo_street2`	Neighborhood and complement delivery address	Alphanumeric must be mapped in	Recommended
`bpmpi_shipTo_city`	Delivery address city	Alphanumeric must be mapped in	Recommended
`bpmpi_shipTo_state`	Billing address state. Brazil, United States, and Canada: enter the state abbreviation of the billing address. Other countries**: enter the country abbreviation for billing.	string that must be	Recommended
`bpmpi_shipto_zipcode`	Delivery address zip code	Alphanumeric must be mapped in, in the format: 99999999	Recommended
`bpmpi_shipto_country`	Delivery address country	Text es that must , e.g., BR	Recommended
`bpmpi_shipTo_shippingmethod`	Shipping method type	lowcost sameday oneday twoday threeday pickup other	Recommended
`bpmpi_shipto_firstusagedate`	Indicates the date of first use of the delivery address	Text AAAA-MM-DD - creation date	Recommended

Shopping cart

Field	Description	Type/Size	Required
`bpmpi_cart_#_description`	Item description	Alphanumeric [max 255 positions]	Recommended
`bpmpi_cart_#_name`	Item name	Alphanumeric [max 255 positions]	Recommended
`bpmpi_cart_#_sku`	Item SKU	Alphanumeric [max 255 positions]	Recommended
`bpmpi_cart_#_quantity`	Cart item quantity	Numeric [max 10 positions]	Recommended
`bpmpi_cart_#_unitprice`	Unit value of the cart item (cents)	Numeric [max 10 positions]	Recommended

User

Field	Description	Type/Size	Required
`bpmpi_useraccount_guest`	Indicates whether the customer is not logged (guest)	Boolean true - yes false - no	Recommended
`bpmpi_useraccount_createddate`	Indicates the account creation date	String AAAA-MM-DD - creation date	Recommended
`bpmpi_useraccount_changeddate`	Indicates the last change date of shopper's account	String AAAA-MM-DD - last alteration date	Recommended
`bpmpi_useraccount_passwordchangeddate`	Indicates the date when the shopper's account password changed	Text AAAA-MM-DD - date of the last password change	Recommended
`bpmpi_useraccount_authenticationmethod`	Shopper's authentication method	01 - No authentication 02 - Store login 03 - Login with federated ID 04 - Login with FIDO authenticator	Recommended
`bpmpi_useraccount_authenticationprotocol`	Data that represents the login protocol carried out in the store	Alphanumeric must be mapped in yo	Recommended
`bpmpi_useraccount_authenticationtimestamp`	The date and time the store was logged in	String that must be mappYYYY-MM-ddTHH:mm:ss	Recommended
`bpmpi_merchant_newcustomer`	Indicates whether the consumer is a new or existing customer with the merchant	Boolean true – yes false – no	Recommended

Device

Field	Description	Type/Size	Required
`bpmpi_device_ipaddress`	IP address of the shopper's machine	Alphanumeric must be mapped in	Yes
`bpmpi_device_#_fingerprint`	Id returned by Device Fingerprint	Alphanumeric must be ma	Recommended
`bpmpi_device_#_provider`	Device Fingerprint provider name	Alphanumeric must be mapped in cardinal inauth threatmetrix	Recommended
`bpmpi_device_#_channel`	Channel from which the transaction came from. Possible values: -Browser -SDK -3RI	Alphanumeric must be mapped in y	Yes

Recurrence

Field	Description	Type/Size	Required
`bpmpi_recurring_type`	Recurring payment type.	Number 1 - First transaction 2 - Subsequent transaction 3 - Modification 4-Cancellation	Recommended, if recurrent transaction
`bpmpi_recurring_validationIndicator`	Indicates whether the recurring payment transaction was validated or not.	Number 0 - Not validated 1 - Validated	Recommended, if recurrent transaction
`bpmpi_recurring_maximumAmount`	Maximum amount agreed by the cardholder.	numeric that must be mapped	Recommended, if recurrent transaction
`bpmpi_recurring_referenceNumber`	Unique reference number for the recurring payment transaction.	Alphanumeric must be mapped in yo	Recommended, if recurrent transaction
`bpmpi_recurring_occurrence`	Indicates how often a recurring payment occurs.	Number 01 - Daily 02 - Twice a week 03 - Weekly 04 - Every ten days 05 - Fortnightly 06- Monthly 07 - Bimonthly 08 - Every three months 09 - Every four months 10 - Every six months 11 - Annually 12 - Unscheduled.	Recommended, if recurrent transaction
`bpmpi_recurring_numberOfPayments`	Total number of payments during the recurring subscription.	Number that must be mappe	Recommended, if recurrent transaction
`bpmpi_recurring_amountType`	Indicates the type of recurring amount agreed by the cardholder.	Supported values: 1 - Recurring payment of fixed value 2 - Recurring payment with maximum value.	Recommended, if recurrent transaction

Airlines

Field	Description	Type/Size	Required
`bpmpi_airline_travelleg_#_carrier`	IATA code for the stretch	Alphanumeric must be mappe	Recommended for airlines
`bpmpi_airline_travelleg_#_departuredate`	Departure date	String AAAA-MM-DD	Recommended for airlines
`bpmpi_airline_travelleg_#_origin`	IATA code from origin airport	Alphanumeric must be mappe	Recommended for airlines
`bpmpi_airline_travelleg_#_destination`	IATA code from destination airport	Alphanumeric must be mappe	Recommended for airlines
`bpmpi_airline_passenger_#_name`	Passenger name	Alphanumeric must be mapped in	Recommended for airlines
`bpmpi_airline_passenger_#_ticketprice`	Ticket price (cents)	Numeric that must be mappe, example:R$125,54 = 12554	Recommended for airlines
`bpmpi_airline_numberofpassengers`	Passenger number	Numeric that must be	Recommended for airlines
`bpmpi_airline_billto_passportcountry`	Code of the country that emitted the passport (ISO Standard Country Codes)	Text es that must	Recommended for airlines
`bpmpi_airline_billto_passportnumber`	Passport number	Alphanumeric must be mapped	Recommended for airlines

Merchant Defined Data

Field	Description	Type/Size	Required
`bpmpi_mdd1`	Extra data defined by the merchant	Alphanumeric [max 255 positions]	No
`bpmpi_mdd2`	Extra data defined by the merchant	Alphanumeric [max 255 positions]	No
`bpmpi_mdd3`	Extra data defined by the merchant	Alphanumeric [max 255 positions]	No
`bpmpi_mdd4`	Extra data defined by the merchant	Alphanumeric [max 255 positions]	No
`bpmpi_mdd5`	Extra data defined by the merchant	Alphanumeric [max 255 positions]	No
`bpmpi_brand_establishment_code`	Amex Establishment Code (EC)	Text [10 positions]	Required for Amex authentications