2. Mapeando as classes

A solução disponibiliza dezenas de classes que devem ser mapeadas em seu código HTML.

Uma vez que a classe é mapeada em determinado campo, o script é capaz de recuperar o valor contido no campo e submetê-lo para compor a requisição de autenticação.

⚠️
Atenção

Quanto maior a quantidade de campos parametrizados, é maior a chance de ter uma autenticação transparente, pois o emissor terá maior subsídio para a análise de risco;

O caracter # indicado no campo deve ser substituído pelo número que representa o índice do item. Exemplo: bpmpi_item_1_productName representa o nome do item 1 do carrinho.

ℹ️
Campo obrigatório para Amex
A Amex exige a parametrização do campo bpmpi_brand_establishment_code em dados do Estabelecimento.

Acesso e Tipo de Autenticação

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_auth`	Booleano que indica se a transação é submetida ou não para o processo de autenticação	Booleano: true – submeter à autenticação false – não submeter à autenticação	Sim
`bpmpi_auth_notifyonly`	Booleano que indica se a transação com cartão será submetida no modo "somente notificação". Neste modo, o processo de autenticação não será acionado, porém, os dados serão submetidos à bandeira. Válido para cartões Mastercard e Visa	Booleano: true – modo somente notificação; false – modo com autenticação	Condicional - obrigatório somente para transações Data Only
`bpmpi_auth_suppresschallenge`	Booleano que indica se ignora ou não o desafio quando houver. Se uma transação autorizada após ignorar o desafio, o liability permanece com o estabelecimento.	Booleano: true – ignorar desafios se houver; false – apresentar desafio se houver	Recomendado
`bpmpi_accesstoken`	Token gerado pela API de Token de Acesso (etapa 1)	Alfanumérico [variável]	Sim

Pedido

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_ordernumber`	Código do pedido no estabelecimento	Alphanumérico [até 50 posições]	Sim
`bpmpi_currency`	Código da moeda	Fixo "BRL"	Sim
`bpmpi_totalamount`	Valor total da transação, enviado em centavos	Numérico [até 15 posições]	Sim
`bpmpi_installments`	Número de parcelas da transação	Numérico [até 2 posições]	Sim
`bpmpi_paymentmethod`	Tipo do cartão a ser autenticado. No caso do cartão múltiplo, deverá especificar um dos tipos, Credit ou Debit	Credit – Cartão de crédito Debit – Cartão de débito	Sim
`bpmpi_cardnumber`	Número do cartão	Numérico [até 19 posições]	Sim
`bpmpi_cardexpirationmonth`	Mês do vencimento do cartão	Numérico [2 posições]	Sim
`bpmpi_cardexpirationyear`	Ano do vencimento do cartão	Numérico [4 posições]	Sim
`bpmpi_cardalias`	Alias do cartão	Alphanumérico [até 128 posições]	Recomendado
`bpmpi_default_card`	Indica se é um cartão padrão do cliente na loja	Booleano true - sim false - não	Recomendado

Características do pedido

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_recurring_enddate`	Identifica a data de término da recorrência	Texto (AAAA-MM-DD)	Recomendado
`bpmpi_recurring_frequency`	Indica a frequência da recorrência	Número 1 - Mensal 2 - Bimestral 3 - Trimestral 4 - Quadrimestral 6 - Semestral 12 - Anual	Recomendado
`bpmpi_recurring_originalpurchasedate`	Identifica a data da 1ª transação que originou a recorrência	Texto (AAAA-MM-DD)	Recomendado
`bpmpi_order_recurrence`	Indica se é um pedido que gera recorrências futuras	Booleano (true ou false)	Recomendado
`bpmpi_order_productcode`	Tipo da compra	PHY: compra de mercadorias CHA: Check acceptance ACF: Financiamento de conta QCT: Transação quase-dinheiro PAL: recarga	Sim
`bpmpi_order_countlast24hours`	Quantidade de pedidos efetuados por este comprador nas últimas 24h	Numérico [até 3 posições]	Recomendado
`bpmpi_order_countlast6months`	Quantidade de pedidos efetuados por este comprador nos últimos 6 meses	Numérico [até 4 posições]	Recomendado
`bpmpi_order_countlast1year`	Quantidade de pedidos efetuados por este comprador no último ano	Numérico [até 3 posições]	Recomendado
`bpmpi_order_cardattemptslast24hours`	Quantidade de transações com o mesmo cartão nas últimas 24h	Numérico [até 3 posições]	Recomendado
`bpmpi_order_marketingoptin`	Indica se o comprador aceitou receber ofertas de marketing	Booleano true – sim false – não	Recomendado
`bpmpi_order_marketingsource`	Identifica a origem da campanha de marketing	Alfanumérico [até 40 posições]	Recomendado
`bpmpi_transaction_mode`	Identifica o canal que originou a transação	M: MOTO R: Varejo S: E-Commerce P: Mobile T: Tablet	Recomendado
`bpmpi_merchant_url`	Endereço do site do estabelecimento.	Alfanumérico [100] Exemplo: `https://www.exemplo.com.br`	Sim

ℹ️
Para usar autenticação 3DS em ambiente sandbox, use "https://localhost" no campo bpmpi_merchant_url.

Cartões pré-pago

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_giftcard_amount`	O total do valor da compra para cartões de presente pré-pagos em valor arredondado	Numérico [até 15 posições], exemplo: R$ 125,54 = 12554	Recomendado
`bpmpi_giftcard_currency`	Código da moeda da transação paga com cartão do tipo pré-pago	Fixo "BRL"	Recomendado

Endereço de cobrança

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_billto_customerid`	Identifica o CPF/CNPJ do comprador	Numérico [11 a 14 posições] 99999999999999	Recomendado
`bpmpi_billto_contactname`	Nome do contato do endereço de cobrança	Alfanumérico [até 120]	Sim
`bpmpi_billto_phonenumber`	Telefone de contato do endereço de cobrança	Numérico [até 15 posições], no formato: 5511999999999	Sim
`bpmpi_billto_email`	E-mail do contato do endereço de cobrança	Alfanumérico [até 255], no formato `[email protected]`	Sim
`bpmpi_billto_street1`	Logradouro e Número do endereço de cobrança	Alfanumérico [até 60]	Sim
`bpmpi_billto_street2`	Complemento e bairro do endereço de cobrança	Alfanumérico [até 60]	Recomendado
`bpmpi_billto_city`	Cidade do endereço de cobrança	Alfanumérico [até 50]	Sim
`bpmpi_billto_state`	Sigla do estado do endereço de cobrança. Brasil, Estados Unidos e Canadá: insira a sigla do estado do endereço de cobrança. Outros países: insira a sigla do país de cobrança.	Texto [2 posições]	Sim
`bpmpi_billto_zipcode`	CEP do endereço de cobrança	Alfanumérico [até 8 posições], no formato: 99999999	Sim
`bpmpi_billto_country`	País do endereço de cobrança	Texto [2 posições] Ex. BR	Sim

Endereço de entrega

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_shipto_sameasbillto`	Indica se utiliza o mesmo endereço fornecido para endereço de cobrança	Booleano (true ou false)	Recomendado
`bpmpi_shipto_addressee`	Nome do contato do endereço de entrega	Alfanumérico [até 60]	Recomendado
`bpmpi_shipTo_phonenumber`	Telefone de contato do endereço de entrega	Numérico [até 15 posições], no formato: 5511999999999	Recomendado
`bpmpi_shipTo_email`	E-mail do contato do endereço de entrega	Alfanumérico [até 255], no formato `[email protected]`	Recomendado
`bpmpi_shipTo_street1`	Logradouro e Número do endereço de entrega	Alfanumérico [até 60]	Recomendado
`bpmpi_shipTo_street2`	Complemento e bairro do endereço de entrega	Alfanumérico [até 60]	Recomendado
`bpmpi_shipTo_city`	Cidade do endereço de entrega	Alfanumérico [até 50]	Recomendado
`bpmpi_shipTo_state`	Sigla do estado do endereço de cobrança. Brasil, Estados Unidos e Canadá: insira a sigla do estado do endereço de cobrança. Outros países: insira a sigla do país de cobrança.	Texto [2 posições]	Recomendado
`bpmpi_shipto_zipcode`	CEP do endereço de entrega	Alfanumérico [até 8 posições], no formato: 99999999	Recomendado
`bpmpi_shipto_country`	País do endereço de cobrança	Texto [2 posições] Ex. BR	Recomendado
`bpmpi_shipTo_shippingmethod`	Tipo do método de envio	lowcost: envio econômico sameday: envio no mesmo dia oneday: envio no dia seguinte twoday: envio em dois dias threeday: envio em três dias pickup: retirada na loja other: outros none: não há envio	Recomendado
`bpmpi_shipto_firstusagedate`	Indica a data de quando houve a primeira utilização do endereço de entrega	Texto AAAA-MM-DD – data da criação	Recomendado

Carrinho de compras

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_cart_#_description`	Descrição do item	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_cart_#_name`	Nome do item	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_cart_#_sku`	SKU do item	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_cart_#_quantity`	Quantidade do item no carrinho	Numérico [até 10 posições]	Recomendado
`bpmpi_cart_#_unitprice`	Valor unitário do item do carrinho em centavos	Numérico [até 10 posições]	Recomendado

Usuário

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_useraccount_guest`	Indica se o comprador é um comprador sem login (guest)	Booleano true – sim false – não	Recomendado
`bpmpi_useraccount_createddate`	Indica a data de quando houve a criação da conta do comprador	Texto AAAA-MM-DD – data da criação	Recomendado
`bpmpi_useraccount_changeddate`	Indica a data de quando houve a última alteração na conta do comprador	Texto AAAA-MM-DD – data da última alteração	Recomendado
`bpmpi_useraccount_passwordchangeddate`	Indica a data de quando houve a alteração de senha da conta do comprador	Texto AAAA-MM-DD – data da última alteração de senha	Recomendado
`bpmpi_useraccount_authenticationmethod`	Método de autenticação do comprador na loja	01- Não houve autenticação 02- Login da própria loja 03- Login com ID federado 04- Login com autenticador FIDO	Recomendado
`bpmpi_useraccount_authenticationprotocol`	Dado que representa o protocolo de login efetuado na loja	Alfanumérico [até 2048 posições]	Recomendado
`bpmpi_useraccount_authenticationtimestamp`	A data e hora que o login foi efetuado na loja	Texto [19 posições] YYYY-MM-ddTHH:mm:SS	Recomendado
`bpmpi_merchant_newcustomer`	Identifica se um comprador novo na loja	Booleano true – sim false – não	Recomendado

Dispositivo

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_device_ipaddress`	Endereço IP da máquina do comprador	Alfanumérico [até 45]	Sim
`bpmpi_device_#_fingerprint`	Id retornado pelo Device Fingerprint	Alfanumérico [sem limitação]	Recomendado
`bpmpi_device_#_provider`	Nome do provedor do Device Fingerprint	Alfanumérico [até 32 posições] cardinal inauth threatmetrix	Recomendado
`bpmpi_device_channel`	Canal por onde chegou a transação. Valores possíveis: Browser SDK 3RI	Alfanúmerico [até 7 posições]	Sim

Recorrência

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_recurring_type`	Tipo de pagamento recorrente.	Número 1 - Primeira transação 2 - Transação subsequente 3 - Modificação 4 - Cancelamento	Recomendado
`bpmpi_recurring_validationIndicator`	Indica se a transação de pagamento recorrente foi validada ou não	Número 0 - Não validado 1 - Validado	Recomendado
`bpmpi_recurring_maximumAmount`	Valor máximo acordado pelo titular do cartão.	Numérico [até 12 posições]	Recomendado
`bpmpi_recurring_referenceNumber`	Número de referência exclusivo para a transação de pagamento recorrente.	Alfanumérico [até 35 posições]	Recomendado
`bpmpi_recurring_occurrence`	Indica a frequência com que ocorre um pagamento recorrente.	Número 01 - Diariamente 02 - Duas vezes por semana 03 - Semanal 04 - Dez dias 05 - A cada 2 semanas 06 - Mensal 07 - Bimestral 08 - Trimestral 09 - Quadrimestral 10 - Semestral 11 - Anual 12 - Não programado.	Recomendado
`bpmpi_recurring_numberOfPayments`	Número total de pagamentos durante a assinatura recorrente.	Numérico [até 2 posições]	Recomendado
`bpmpi_recurring_amountType`	Indica o tipo de valor recorrente acordado pelo titular do cartão.	Valores suportados: 1 - Pagamento recorrente de valor fixo 2 - Pagamento recorrente com valor máximo.	Recomendado

Companhias aéreas

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_airline_travelleg_#_carrier`	Código IATA para o trecho	Alfanumérico [2 posições]	Recomendado
`bpmpi_airline_travelleg_#_departuredate`	Data de partida	Texto AAAA-MM-DD	Recomendado
`bpmpi_airline_travelleg_#_origin`	Código IATA do aeroporto de origem	Alfanumérico [5 posições]	Recomendado
`bpmpi_airline_travelleg_#_destination`	Código IATA do aeroporto de destino	Alfanumérico [5 posições]	Recomendado
`bpmpi_airline_passenger_#_name`	Nome do passageiro	Alfanumérico [até 60 posições]	Recomendado
`bpmpi_airline_passenger_#_ticketprice`	O valor da passagem em centavos Numérico [até 15 posições], exemplo: R$ 125,54 = 12554	Recomendado
`bpmpi_airline_numberofpassengers`	Número de passageiros	Numérico [3 posições]	Recomendado
`bpmpi_airline_billto_passportcountry`	Código do país que emitiu o passaporte (ISO Standard Country Codes)	Texto [2 posições]	Recomendado
`bpmpi_airline_billto_passportnumber`	Número do passaporte	Alfanumérico [40 posições]	Recomendado

Estabelecimento

Campo	Descrição	Tipo/Tamanho	Obrigatório
`bpmpi_mdd1`	Dado Extra definido pelo lojista	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_mdd2`	Dado Extra definido pelo lojista	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_mdd3`	Dado Extra definido pelo lojista	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_mdd4`	Dado Extra definido pelo lojista	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_mdd5`	Dado Extra definido pelo lojista	Alfanumérico [até 255 posições]	Recomendado
`bpmpi_brand_establishment_code`	Código de estabelecimento (EC) Amex. Obrigatório em autenticações Amex.	Texto [10 posições]	Obrigatório em autenticações Amex