Resposta CustomerWallet

Objeto com as informações relativas a um wallet comprador. Contém a lista dos cartões salvos com a referência comprador.

Referência da resposta

Referência comprador.

Formato

Data de rescisão do Token.

Formato

Data e hora de criação do Token Catão.

Formato

Token associado a um meio de pagamento.

Formato

Tipo de meio de pagamento. Exemplo: PAYCONIQ

Formato

Status do token.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
ACTIVE	O cartão pode ser usado para um pagamento (valor por default)
EXPIRED	O método de pagamento venceu.
CANCELLED	O cartão está logicamente removido (cancelado)
all	Todos os status combinados

Código de identificação do comprado para o Estabelecimento Comercial.

Formato

Endereço e-mail do comprador.

• Especificações de estrutura de e-mail: RFC-2822

Formato

Endereço de faturamento.

Advertência: Os símbolos > e < não são autorizados.

Formato

Informações complementares sobre o endereço de faturamento.

Advertência: Os símbolos > e < não são autorizados.

Formato

Tipo de cliente.

Formato

Valores possíveis

valores	Descrição
PRIVATE	Cliente de tipo Pessoa física
COMPANY	Cliente de tipo Pessoa Jurídica

Telefone mobile do comprador.

Aceita todos os formatos:

Exemplos:

• 0623456789
• +33623456789
• 0033623456789
• (+34) 824 65 43 21
• 87 77 12 34

Formato

Cidade de faturamento.

Formato

País do comprador (em maiúscula, conforme à norma ISO 3166-1 alfa-2).

Formato

Valores possíveis

Exemplos de valores possíveis:

País	Código
ÁUSTRIA	AT
Brasil	BR
CORSEGA	FR
COSTA DO MARFIM	CI
FRANÇA	FR
GUADALUPE	GP
ÍNDIA	IN
MARTINICA	MQ
NOVA-CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
POLINÉSIA FRANCESA	PF

Bairro do endereço de faturamento.

Formato

Nome do comprador.

Formato

CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.

Formato

Tipo de documento de identidade.

Formato

Código do idioma do comprador, conforme a norma ISO 639-1.

Permite especificar o idioma de envio dos e-mails de confirmação de pagamento.

Formato

Valores possíveis

Exemplos de valores possíveis:

Idioma	Código
Alemão (Alemanha)	DE
Inglês (Reino-Unido)	EN
Inglês (Estados-Unidos)	EN
Chinês (Tradicional)	ZH
Espanhol (Espanha)	ES
Espanhol (Chile)	ES
Francês (França)	FR
Italiano (Itália)	IT
Japonês (Japão)	JP
Holandês (Holanda)	NL
Polonês (Polônia)	PL
Português (Brasil)	PT
Português (Portugal)	PT
Russo (Rússia)	RU

Sobrenome do comprador.

Formato

Razão social.

Formato

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

• 0123456789
• +33123456789
• 0033123456789
• (00.571) 638.14.00
• 40 41 42 42

Formato

Região (estado) do endereço de faturamento. Recomendado mas não obrigatório passar o valor em ISO-3166-2.

Formato

Número de rua do endereço de faturamento.

Carateres aceites:

• Caracteres alfabéticos (de "A" a "Z" e de "a" a "z")
• Espaço

Formato

Estado civil do comprador.

Exemplos:

• Sr.
• Sr.
• Sra.

Formato

CEP do endereço de faturamento.

Formato

Endereço de entrega.

Advertência: Os símbolos > e < não são autorizados.

Formato

Segunda linha do endereço de entrega.

Advertência: Os símbolos > e < não são autorizados.

Formato

Tipo de cliente.

Formato

Valores possíveis

valores	Descrição
PRIVATE	Cliente de tipo Pessoa física
COMPANY	Cliente de tipo Pessoa Jurídica

Cidade de entrega.

Formato

País de entrega (em maiúscula, conforme a norma ISO 3166-1 alfa-2).

Formato

Valores possíveis

Exemplos de valores possíveis:

País	Código
ÁUSTRIA	AT
Brasil	BR
CORSEGA	FR
COSTA DO MARFIM	CI
FRANÇA	FR
GUADALUPE	GP
ÍNDIA	IN
MARTINICA	MQ
NOVA-CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
POLINÉSIA FRANCESA	PF

Nome da empresa que entrega o produto.

Formato

Bairro do endereço de faturamento.

Formato

Nome do destinatário.

Formato

CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.

Formato

Sobrenome do comprador.

Formato

Razão social para uma entrega em uma empresa.

Formato

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

• 0123456789
• +33123456789
• 0033123456789
• (00.571) 638.14.00
• 40 41 42 42

Formato

Modo de entrega.

Formato

Valores possíveis

VALOR	Descrição
RECLAIM_IN_SHOP	Retirada de mercadoria na loja.
RELAY_POINT	Utilização de uma rede de pontos de entrega terceirizados (Kiala, Alveol, etc).
RECLAIM_IN_STATION	Retirada em um aeroporto, uma agência de viagens ou outros.
PACKAGE_DELIVERY_COMPANY	Entrega por transportadora (Colissimo, UPS, etc).
ETICKET	Emissão de uma passagem eletrônica, download de produtos virtuais.
CARD_HOLDER_ADDRESS	Entrega no endereço do comprador. Reservado para um uso futuro.
VERIFIED_ADDRESS	Entrega em um endereço verificado. Reservado para um uso futuro.
NOT_VERIFIED_ADDRESS	Entrega em um endereço não verificado. Reservado para um uso futuro.
SHIP_TO_STORE	Entrega na loja. Reservado para um uso futuro.
DIGITAL_GOOD	Entrega digital. Reservado para um uso futuro.
ETRAVEL_OR_ETICKET	Passagem eletrônica. Reservado para um uso futuro.
OTHER	Outros Reservado para um uso futuro.
PICKUP_POINT	Entrega em ponto de retirada. Reservado para um uso futuro.
AUTOMATED_PICKUP_POINT	Entrega em ponto de retirada automático. Reservado para um uso futuro.

Prazo de entrega.

Formato

Valores possíveis

Exemplos de valores possíveis:

VALOR	Descrição
STANDARD	Entrega padrão.
EXPRESS	Entrega em menos de 24h.
PRIORITY	Entrega prioritária (Click & Collect)

Região do endereço de faturamento.

Formato

Número de rua do endereço de entrega.

Carateres aceites:

• Caracteres alfabéticos (de "A" a "Z" e de "a" a "z")
• Espaço

Formato

CEP do endereço de faturamento.

Formato

Endereço IP do comprador.

Formato

Código único de sessão. Usado no Brasil pelo analisador de risco ClearSale. Pode conter maiúsculas, minúsculas, números e hifens ([A-Z][a-z], 0-9, _, -).

Formato

Header « User-Agent » do navegador do comprador (HTTP/1.1 - RFC. 2616).

Formato

Header « Accept » do navegador do comprador (HTTP/1.1 - RFC. 2616).

Formato

Valor do seguro para a totalidade do pedido expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

Montante do frete para o total do pedido, na menor unidade monetária da moeda (o centavo para o Real). Ex: 1234 para 12,34 BRL.

Exemplo: 30050 para 300,50 EUR.

Formato

Valor dos impostos para a totalidade do pedido expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

cardItemInfo é uma lista de objetos Customer/ShoppingCartItemInfo.

Permite descrever cada artigo do carrinho.

Formato

Valor do produto expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

Nome do produto.

Formato

Quantidade de produto.

Formato

Referência produto.

Formato

Tipo de produto.

Valores possíveis

VALOR	Descrição
FOOD_AND_GROCERY	Produtos alimentares e de mercadinho
AUTOMOTIVE	Automóvel / Moto
ENTERTAINMENT	Lazer / Cultura
HOME_AND_GARDEN	Casa e jardim
HOME_APPLIANCE	Equipamentos para a casa
AUCTION_AND_GROUP_BUYING	Leilões e compras em grupo
FLOWERS_AND_GIFTS	Flores e presentes
COMPUTER_AND_SOFTWARE	Computadores e softwares
HEALTH_AND_BEAUTY	Saúde e beleza
SERVICE_FOR_INDIVIDUAL	Serviços para pessoa física
SERVICE_FOR_BUSINESS	Serviços para pessoa jurídica
SPORTS	Esportes
CLOTHING_AND_ACCESSORIES	Roupas e acessórios
TRAVEL	Viagem
HOME_AUDIO_PHOTO_VIDEO	Som, imagem e vídeo
TELEPHONY	Telefonia

Formato

Tipo de produto.

Valor do imposto sobre o produto (apresentado na menor unidade da moeda).

Valores possíveis

VALOR	Descrição
Um número inteiro	Valor da transação. O valor dela deve ser um número inteiro positivo (ex: 1234 para 12,34 EUR).
Um número decimal, inferior a 100	Percentagem aplicada sobre o valor. Exemplos: 20.0 ou 19.6532

Para mencionar uma percentagem aplicada sobre o valor do produto em questão, o valor deve ter no máximo 4 dígitos após a virgula. A decimal é obrigatória para mencionar uma percentagem. A decimal é marcada pelo símbolo ".".

Formato

Código país do cartão.

Formato

Rede do cartão.

Meio de pagamento	Tipo de cartão (effectiveBrand)
Carte enseigne Accord	ACCORD_STORE
Carte enseigne Accord - Mode sandbox	ACCORD_STORE_SB
Alipay	ALIPAY
Alma en 2 fois	ALMA_2X
Alma en 3 fois	ALMA_3X
Alma en 4 fois	ALMA_4X
Alma en 10 fois	ALMA_10X
Alma en 12 fois	ALMA_12X
American Express	AMEX
Titre-Restaurant Dématérialisé Apetiz	APETIZ
Paiement par Wallet Apple Pay	APPLE_PAY
Carte Cpay	AURORE-MULTI
Bancontact Mistercash	BANCONTACT
Bizum	BIZUM
CB	CB
Titre-Restaurant Dématérialisé Chèque Déjeuner	CHQ_DEJ
Carte Aurore "CORA"	CORA
Carte Aurore "CORA blanche"	CORA_BLANCHE
Carte Aurore "CORA Premium"	CORA_PREM
Carte Aurore "CORA VISA"	CORA_VISA
Titre-Restaurant Dématérialisé Conecs	CONECS
Diners	DINERS
Discover	DISCOVER
e-carte bleue	E-CARTEBLEUE
Ticket Eco Chèque Edenred	EDENRED_EC
Ticket Sports & Culture Edenred	EDENRED_SC
Ticket Compliment Edenred	EDENRED_TC
Ticket Restaurant Edenred	EDENRED_TR
Paiement en 3X Franfinance	FRANFINANCE_3X
Paiement en 4X Franfinance	FRANFINANCE_4X
Paiement en 3x sans frais par BNPP PF	FULLCB3X
Paiement en 4x sans frais par BNPP PF	FULLCB4X
Giropay	GIROPAY
Paiement par Wallet Google Pay	GOOGLEPAY
iDeal Internet Banking	IDEAL
Carte Cadeau Illicado	ILLICADO
Carte Cadeau Illicado - Mode sandbox	ILLICADO_SB
Virement SEPA	IP_WIRE
JCB	JCB
Maestro	MAESTRO
Mastercard	MASTERCARD
Multibanco	MULTIBANCO
MyBank	MYBANK
Payconiq	PAYCONIQ
PayDirekt	PAYDIREKT
PAYPAL	PayPal
PAYPAL_BNPL	PayPal Pay Later
PAYPAL_SB	PayPal - Mode sandbox
PAYPAL_BNPL_SB	PayPal Pay Later- Mode sandbox
PostFinance	POSTFINANCE
PostFinance E-finance	POSTFINANCE_EFIN
Przelewy24	PRZELEWY24
Prélèvement Bancaire SEPA DIRECT DEBIT	SDD
Titre-Restaurant Dématérialisé Sodexo	SODEXO
Sofort Banking	SOFORT_BANKING
Union Pay	UNION_PAY
BHIM-UPI	BHIM-UPI
Visa	VISA
Visa Electron	VISA_ELECTRON
Vpay	VPAY
WeChat	WECHAT

Formato

Código produto do cartão usado para o pagamento.

visa	Designação
a	Visa Traditional
B	Visa Traditional Rewards
C	Visa Signature
D	Visa Signature Preferred
e	Proprietary ATM
F	Visa Classic
G	Visa Business
G1	Visa Signature Business
G2	Reserved
G3	Visa Business Enhanced
G4	Visa Infinite Business
G5	Visa Business Rewards
H	Reserved
I	Visa Infinite
I1	Visa Infinite Privilege
I2	Visa Ultra High Net Worth
J	Reserved
J1	Reserved
J2	Reserved
J3	Visa Healthcare
J4	Reserved
K	Visa Corporate T&E
K1	Visa GSA Corporate T&E
L	Electron
N	Visa Platinium
N1	TBA
N2	Visa Select
P	Visa Gold
Q	Private Label
Q1	Reserved
Q2	Private Label Basic
Q3	Private Label Standard
Q4	Private Label Enhanced
Q5	Private Label Specialized
Q6	Private Label Premium
R	Proprietary
S	Visa Purchasing
S1	Visa Purchasing
S2	Visa Purchasing
S3	Visa Purchasing
S4	Government Services Loan
S5	Commercial Transport EBT
S6	Business Loan
S7	Visa Distribution
T	Reserved
U	Visa TravelMoney
V	Visa VPay
W	Reserved
X	Reserved
Y	Reserved
Z	Reserved

mastercard	Designação
BPD	MASTERCARD BUSINESS PREMIUM DEBIT
CIR	CIRRUS
DAG	GOLD DEBIT MASTERCARD SALARY
DAP	PLATINUM DEBIT MASTERCARD SALARY
DAS	STANDARD DEBIT MASTERCARD SALARY
DDB	DOMESTIC DEBIT BRAND
DLG	DEBIT GOLD DELAYED DEBIT
DLH	DEBIT WORLD EMBOSSED DELAYED DEBIT
DLP	DEBIT PLATINUM DELAYED DEBIT
DLS	MASTERCARD CARD-DELAYED DEBIT
DOS	STANDARD DEBIT MASTERCARD SOCIAL
DWF	DEBIT MASTERCARD HUMANITARIAN PREPAID
Sr.	mastercard
MAB	WORLD ELITE MASTERCARD
MAC	MASTERCARD CORPORATE WORLD ELITE
MAP	MASTERCARD COMMERCIAL PAYMENTS ACCOUNT
MBB	MASTERCARD PREPAID CONSUMER
MBC	MASTERCARD PREPAID VOUCHER
MBD	MASTERCARD PROFESSIONAL DEBIT BUSINESS CARD
MBE	MASTERCARD ELECTRONIC BUSINESS CARD
MBK	MASTERCARD BLACK
MBP	MASTERCARD UNKNOWN PRODUCT
MBS	MASTERCARD B2B PRODUCT
MBT	MASTERCARD CORPORATE PREPAID TRAVEL
MBW	WORLD MASTERCARD BLACK EDITION – DEBIT
MCB	MASTERCARD BUSINESS CARD
MCC	MASTERCARD CREDIT MIXED BIN CARD
MCD	MASTERCARD DEBIT CARD
MCE	MASTERCARD ELECTRONIC CARD
MCF	MASTERCARD FLEET CARD
MCG	MASTERCARD GOLD CARD
MCH	MASTERCARD PREMIUM CHARGE
MCO	MASTERCARD CORPORATE CARD
MCP	MASTERCARD PURCHASING CARD
MCS	MASTERCARD STANDARD CARD
MCT	TITANIUM MASTERCARD CARD
MCV	MERCHANT BRANDED PROGRAM
MCW	WORLD MASTERCARD CARD
MDB	DEBIT MASTERCARD BUSINESSCARD CARD
MDG	DEBIT GOLD MASTERCARD CARD
MDH	DEBIT OTHER EMBOSSED
MDJ	DEBIT OTHER 2 EMBOSSED
MDL	BUSINESS DEBIT OTHER EMBOSSED
MDN	BUSINESS DEBIT OTHER 2 EMBOSSED
MDO	DEBIT OTHER CARD
MDP	DEBIT PLATINUM CARD
MDR	DEBIT BROKERAGE CARD
MDS	DEBIT MASTERCARD CARD
MDT	MASTERCARD BUSINESS DEBIT
MDW	WORLD ELITE DEBIT MASTERCARD
MEB	MASTERCARD EXECUTIVE BUSINESS CARD
MEC	MASTERCARD ELECTRONIC COMMERCIAL CARD
MEF	ELECTRONIC PAYMENT ACCOUNT
MEO	MASTERCARD CORPORATE EXECUTIVE CARD
MET	TITANIUM DEBIT MASTERCARD CARD
MFB	FLEX WORLD ELITE
MFD	FLEX PLATINUM
MFE	FLEX CHARGE WORLD ELITE
MFH	FLEX WORLD
MFL	FLEX CHARGE PLATINUM
MFW	FLEX CHARGE WORLD
MGF	MASTERCARD GOUVERNMENT COMMERCIAL CARD
MHA	MASTERCARD HEALTHCARE PREPAID NON-TAX
MHB	MASTERCARD HSA SUBSTANTIATED (DEBIT MASTERCARD)
MHD	HELOC DEBIT STANDARD
MHH	MASTERCARD HSA NON-SUBSTANTIATED (DEBIT MASTERCARD)
MHL	HELOC DEBIT GOLD
MHM	HELOC DEBIT PLATINUM
MHN	HELOC DEBIT PREMIUM
MIA	PREPAID MASTERCARD UNEMBOSSED STUDENT CARD
MIP	PREPAID DEBIT MASTERCARD STUDENT CARD
MIU	DEBIT MASTERCARD UNEMBOSSED
MLA	MASTERCARD CENTRAL TRAVEL SOLUTIONS AIR CARD
MLD	MASTERCARD DISTRIBUTION CARD
MLL	MASTERCARD CENTRAL TRAVEL SOLUTIONS LAND CARD
MNF	MASTERCARD PUBLIC SECTOR COMMERCIAL CARD
MNW	MASTERCARD NEW WORLD
MOC	MASTERCARD UNKNOWN PRODUCT
MOG	MAESTRO GOLD
MOP	MAESTRO PLATINIUM
MOW	MAESTRO WORLD
MPA	MASTERCARD PREPAID DEBIT STANDARD-PAYROLL
MPB	PREFERRED BUSINESS CARD
MPC	MPC
MPD	MASTERCARD FLEX PREPAID
MPF	MASTERCARD PREPAID DEBIT STANDARD-GIFT
MPG	MASTERCARD UNEMBOSSED PREPAID STUDENT CARD
MPH	MASTERCARD CASH PREPAID
MPJ	PREPAID DEBIT MASTERCARD CARD GOLD
MPK	PREPAID MASTERCARD GOUVERNMENT COMMERCIAL CARD
MPL	PLATINIUM MASTERCARD CARD
MPM	MASTERCARD PREPAID DEBIT STANDARD-CONSUMER INCENTIVE
MPN	MASTERCARD PREPAID DEBIT STANDARD-INSURANCE
MPO	MASTERCARD PREPAID DEBIT STANDARD-OTHER
MPP	PRE-PAID CARD
MPR	MASTERCARD PREPAID DEBIT STANDARD-TRAVEL
MPT	MASTERCARD PREPAID DEBIT STANDARD-TEEN
MPV	MASTERCARD PREPAID DEBIT STANDARD-GOVERNMENT
MPW	DEBIT MASTERCARD BUSINESS CARD PREPAID WORK B2B
MPX	MASTERCARD PREPAID DEBIT STANDARD-FLEX BENEFIT
MPY	MASTERCARD PREPAID DEBIT STANDARD-EMPLOYEE INCENTIVE
MPZ	MASTERCARD PREPAID DEBIT STANDARD – GOVERNMENT CONSUMER
MRC	MASTERCARD ELECTRONIC CONSUMER PREPAID
MRF	MASTERCARD EUROPEAN REGULATED INDIVIDUAL PAY
MRG	MASTERCARD STANDARD PREPAID
MRH	MASTERCARD UNKNOWN PRODUCT
MRJ	PREPAID MASTERCARD GOLD CARD
MRK	PREPAID MASTERCARD PUBLIC SECTOR COMMERCIAL CARD
MRL	PREPAID MASTERCARD ELECTRONIC COMMERCIAL CARD (NON-US)
MRO	MASTERCARD REWARDS ONLY
MRP	STANDARD RETAILER CENTRIC PAYMENTS
MRW	MASTERCARD CREDIT BUSINESS CARD PREPAID
MSA	PREPAID MAESTRO PAYROLL CARD
MSB	MAESTRO SMALL BUSINESS CARD
MSF	PREPAID MAESTRO GIFT CARD
MSG	PREPAID MAESTRO CONSUMER RELOADABLE CARD
MSI	maestro
MSJ	PREPAID MAESTRO GOLD
MSM	PREPAID MAESTRO CONSUMER PROMOTION CARD
MSN	PREPAID MAESTRO INSURANCE CARD
MSO	PREPAID MAESTRO OTHER CARD
MSQ	RESERVED FOR FUTURE USE
MSR	PREPAID MAESTRO TRAVEL CARD
MST	PREPAID MAESTRO TEEN CARD
MSV	PREPAID MAESTRO GOVERNMENT BENEFIT CARD
MSW	PREPAID MAESTRO CORPORATE CARD
MSX	PREPAID MAESTRO FLEX BENEFIT CARD
MSY	PREPAID MAESTRO EMPLOYEE INSENTIVE CARD
MSZ	PREPAID MAESTRO EMERGENCY ASSISTANCE CARD
MTP	MASTERCARD PLATINUM PREPAID TRAVEL (UK AND BRAZIL)
MUW	WORLD DOMESTIC AFFLUENT
MWB	WORLD MASTERCARD FOR BUSINESS
MWD	WORLD DEFERRED
MWE	MASTERCARD WORLD ELITE
MWF	MASTERCARD HUMANITARIAN PREPAID
MWO	MASTERCARD CORPORATE WORLD
MWR	WORLD RETAILER CENTRIC PAYMENTS
OLB	MAESTRO SMALL BUSINESS DELAYED DEBIT
OLG	MAESTRO GOLD DELAYED DEBIT
OLP	MAESTRO PLATINUM DELAYED DEBIT
OLS	MAESTRO-DELAYED DEBIT
OLW	MAESTRO WORLD DELAYED DEBIT
PVA	PRIVATE LABEL A
PVB	PRIVATE LABEL B
PVC	PRIVATE LABEL C
PVD	PRIVATE LABEL D
PVE	PRIVATE LABEL E
PVF	PRIVATE LABEL F
PVG	PRIVATE LABEL G
PVH	PRIVATE LABEL H
PVI	PRIVATE LABEL I
PVJ	PRIVATE LABEL J
PVL	PRIVATE LABEL CARD
SAG	GOLD MASTERCARD SALARY–IMMEDIATE DEBIT
SAL	STANDARD MAESTRO SALARY
SAP	PLATINUM MASTERCARD SALARY–IMMEDIATE DEBIT
SAP	PLATINUM MASTERCARD SALARY IMMEDIATE DEBIT
SAS	STANDARD MASTERCARD SALARY–IMMEDIATE DEBIT
SOS	STANDARD MASTERCARD SOCIAL–IMMEDIATE DEBIT
SUR	PREPAID MASTERCARD UNEMBOSSED (NON-US)
SUR	PREPAID UNEMBOSSED MASTERCARD CARD (NON-US)
TBE	MASTERCARD ELECTRONIC BUSINESS IMMEDIATE DEBIT
TCB	MASTERCARD BUSINESS CARD-IMMEDIATE DEBIT
TCC	MASTERCARD MIXED BIN-IMMEDIATE DEBIT
TCE	MASTERCARD ELECTRONIC IMMEDIATE DEBIT
TCF	MASTERCARD FLEET CARD IMMEDIATE DEBIT
TCG	LD MASTERCARD CARD-IMMEDIATE DEBIT
TCO	MASTERCARD (CORPORATE) IMMEDIATE DEBIT
TCP	MASTERCARD PURCHASING CARD IMMEDIATE DEBIT
TCS	MASTERCARD STANDARD CARD-IMMEDIATE DEBIT
TCW	WORLD SIGNIA MASTERCARD CARD-IMMEDIATE DEBIT
TEB	MASTERCARD EXECUTIVE BUSINESS CARD IMMEDIATE DEBIT
TEC	MASTERCARD ELECTRONIC COMMERCIAL IMMEDIATE DEBIT
TEO	MASTERCARD CORPORATE EXECUTIVE IMMEDIATE DEBITCARD
TIU	TIU
TNF	MASTERCARD PUBLIC SECTOR COMMERCIAL CARD IMMEDIATE DE
TNW	MASTERCARD NEW WORLD-IMMEDIATE DEBIT
TPB	PREFERRED BUSINESS CARD IMMEDIATE DEBIT
TPL	PLATINUM MASTERCARD IMMEDIATE DEBIT
TWB	WORLD MASTERCARD BLACK EDITION IMMEDIATE DEBIT
WBE	MASTERCARD UNKNOWN PRODUCT
WDR	WORLD DEBIT MASTERCARD REWARDS
WMR	WORLD MASTERCARD REWARDS

CB	Designação
1	Cartão nacional de débito
2	Cartão nacional de débito e de pagamento
3	Cartão nacional de pagamento
4	Cartão nacional de pagamento e de débito com autorização sistemática
5	Cartão nacional de pagamento com autorização sistemática

Outros códigos produtos	Designação
AX	AMERICAN EXPRESS
DI	Discover
DN	Diners
JC	JCB

Formato

Código banco associado ao banco emissor.

Formato

Nome do banco associado ao banco emissor.

Formato

Mês de vencimento com 2 dígitos. Exemplo: "09" para setembro.

Formato

Ano de vencimento com 2 dígitos. Exemplo: "25" para 2025.

Formato

Número de contrato Estabelecimento Comercial. Se este campo é informado, tomar cuidado em utilizar o contrato certo em relação à rede do cartão.

Um contrato STONE não pode ser usado para uma transação AMEX.

Formato

Número de cartão truncado.

Formato

Procedência do pagamento.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
EC	E-Commerce: os dados do meio de pagamento são digitados pelo comprador. Este valor permite ter uma autenticação alta no pagamento.
MOTO	MAIL OR TELEPHONE ORDER: Digitação realizada por um operador. Os dados do meio de pagamento são enviados por correio ou por e-mail. Requer um contrato de tipo VAD.
CC	Call Center: pagamento efetuado via um call center. Requer um contrato de tipo VAD.
OTHER	Outro canal de venda. Valor de saída retornado para pagamentos feitos desde Back Office EC, pagamentos por arquivo, pagamentos recorrentes, pagamentos por proximidade, reembolsos do CMS Shopify.
Absent ou null	O valor por default é "EC".

Valor da autorização.

Formato

Código da moeda usada na solicitação de autorização.

Formato

Data e hora da solicitação de autorização.

Formato

Número da solicitação de autorização.

Formato

Código retorno da solicitação de autorização.

Ver Lista dos códigos retorno autorização para maiores detalhes.

Formato

Especifica de que maneira é realizada a solicitação de autorização.

Valores possíveis

valores	Descrição
MARK	Uma pré-autorização de um valor nulo ou unitário foi realizada, ver abaixo.
FULL	Autorização para o valor total solicitada no pedido.

Quando authorizationMode tem o valor MARK : Uma autorização de 1 EUR (ou solicitação de informações na rede CB se for compatível com o adquirente) foi realizada para verificar a validade do cartão. Isso acontece quando a data de captura ultrapassa o período de validade de uma autorização (7 dias para VISA / Mastercard / CB / AMEX na França por exemplo).

Formato

token único de autenticação, no formato UUID.

Formato

Código único da sessão de autenticação.

Formato

Tipo da instrução para ser realizada.

Formato

Valores possíveis

valores	Descrição
FORM	Instrução de tipo redirecionamento por formulário

Nome da instrução

Valores possíveis

VALOR	Descrição
CHALLENGE	Instrução Challenge, que permite a autenticação interativa do usuário com o ACS
FINGERPRINT	Instrução Fingerprint, que permite identificar o usuário com o ACS

Formato

Tipo de resposta recebida. A interpretação do restante da resposta depende deste atributo.

Valores possíveis

VALOR	Descrição
AuthenticationInstruction	Resposta de tipo Instrução
AuthenticationResult	Resposta de tipo Resultado final

Formato

Prazo máximo de espera da resposta para a execução de uma instrução, apresentado em segundos. Após este prazo, será preciso acionar o retorno para o servidor da plataforma de pagamento para obter o resultado final.

Formato

Método (verbo) usado para a solicitação.

Valores possíveis

VALOR	Descrição
DELETE	Método Delete
GET	Método Get
PATCH	Método Patch
POST	Método Post
PUT	Método Put

Formato

Url para qual apresentar o formulário http.

Formato

Lista dos parâmetros do corpo da solicitação, sob a forma “nome”: “valor”.

Formato

Lista dos cabeçalhos da solicitação http, sob a forma de “nome”: “valor”

Formato

Tipo de elemento alvo html no qual deverá ser materializado a instrução.

Valores possíveis

VALOR	Descrição
IFRAME	iFrame

Formato

Altura do alvo html em pixeis.

Formato

Boolean que indica se o alvo html deve ser visível ou não.

Formato

Largura do alvo html em pixeis.

Formato

Campo técnico de uso interno, que permite exibir ou ocultar a URL do ACS.

Formato

Indica se o EC solicita um challenge ou não.

Valores possíveis

valores	Descrição
NO_PREFERENCE	Sem referência particular
NO_CHALLENGE_REQUESTED	O challenge não foi explicitamente solicitado
CHALLENGE_REQUESTED	O challenge é solicitado pelo Estabelecimento Comercial

Formato

Nome do protocolo de autenticação do portador do cartão.

Valores possíveis

VALOR	Descrição
THREEDS	Protocolo 3D Secure

Formato

Booleano que indica se a autenticação deve ser realizada em modo simulação. Se você valorizar este campo obrigatório como:

• true, você ativa o modo simulação.
• false, você não ativa o modo simulação.

Este modo permite realizar a integração EC sem estar em produção ou usando cartões reais.

Formato

Rede na qual o cartão foi autenticado.

Redes atualmente suportadas

VALOR
CB
VISA
MASTERCARD
AMEX_SAFEKEY
PROTECTBUY

Formato

Versão do protocolo de autenticação do portador do cartão.

Versões suportadas atualmente

VALOR	Descrição
1.0.2	Versão 1.0.2
2.1.0	Versão 2.1.0
2.2.0	Versão 2.2.0

Formato

O tipo de autenticação que ocorreu.

Valores possíveis

VALOR	Descrição
FRICTIONLESS	Autenticação em modo Frictionless, ou seja de forma transparente pelo cliente
CHALLENGE	Autenticação com Challenge, o cliente teve que autenticar-se explicitamente com o ACS
DATA_ONLY	Autenticação assumida pelo DS sem interação do cliente

Formato

O Commerce Indicator, chamado ECI (Electronic Commerce Indicator) para o protocolo 3DS. Indicador retornado pelo ACS para apresentar os resultados da tentativa de autenticação do portador do cartão.

No caso de uma autenticação sem pagamento (caso do registro de um cartão), a Mastercard pode retornar os dois valores seguintes:

VALOR	Descrição
N0	Not authenticated
N2	Authenticated

Formato

O status de autenticação, ou seja o resultado positivo/negativo da autenticação.

Valores possíveis

VALOR	Descrição
ATTEMPT	Prova de tentativa de autenticação quando a autenticação não está disponível
ENROLLED_UNAVAILABLE	Não foi possível obter o status de inscrição
FAILED	Autenticação errada
NOT_ENROLLED	Cartão não inscrito
SUCCESS	Autenticação sucedida
UNAVAILABLE	A autenticação não pôde acabar (erro técnico, etc...)
DISABLED	Modo seletivo da autenticação solicitada
REJECTED	Autenticação recusada pela ACS

Formato

O tipo de autenticação que ocorreu.

Valores possíveis

VALOR	Descrição
dsTransId	O campo é procedente do campo dsTransId do protocolo 3DS V2

Formato

Valor do código da transação de autenticação conhecido pela rede bancária.

O comprimento do campo varia dependendo do protocolo de autenticação.

PROTOCOLO	Formato / Comprimento	valor Exemplo:
3DS v2 (dsTransId)	cadeia / 32 caracteres alfanuméricos + 4 travessões	4317fdc3-ad24-5443-8000-000000000891

Formato

Tipo do valor de autenticação.

Valores possíveis

VALOR	Descrição
AEVV	American Express Verification Value (usado pela Amex)
CAVV	Cardholder Authentication Verification Value (usado pela VISA)
AAV	Accountholder Authentication Value (usado pela Mastercard)

Formato

Valor de autenticação final (em função do DS este valor pode se chamar CAVV, AEVV ou AAV). Uma cadeia de caracteres codificados com base64 de 28 caracteres de comprimento.

Formato

Tipo da extensão de resultado.

Formato

Valores possíveis

valores	Descrição
THREEDS_V2	Extensão para as autenticações 3DS Secure v2

Identifiant de transaction de l'ACS. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration

Formato

Score CB como definido na extensão CB da mensagem ARES.

Formato

Código do algoritmo usado para gerar o Valor de Autenticação (usado durante a autorização)

Valores possíveis

VALOR	Descrição
0	HMAC
1	CVV
2	CVV com ATN
3	MasterCard SPA

Formato

Código adicional informativo sobre a origem do resultado. Ex: DS_TIMEOUT.

Formato

Mensagem adicional informativa sobre a origem do resultado.

Formato