Resposta Payment
Payment é um objeto que descreve o resultado de um pagamento. É retornado pelo web service REST Charge/CreatePayment , e pelo IPN.
O objeto Payment pode conter mais de uma transações.
Estrutura do objeto Payment
O objeto Payment tem a estrutura seguinte:
No caso geral, a lista transactions contem apenas uma transação. Mas no caso do pagamento fracionado (o pedido é pago com mais de um meio de pagamento), várias transações podem ser criadas. É a razão pela qual você deve sempre usar os campos orderStatus e orderCycle para verificar o status do pedido.
Referência da resposta
orderStatus
Status consolidado das transações presentes no pedido.
Descrição
Um pedido pode conter mais de uma transação. OrderStatus consolida o status de todas as transações referentes ao pedido.
Para maiores informações, consultar: Ciclo de vida das transações
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| PAID | O pedido está pago |
| UNPAID | O pedido não foi pago |
| RUNNING | Pedido em andamento |
| PARTIALLY_PAID | O pedido foi parcialmente pago |
| ABANDONED | A pedido foi abandonada |
Formato
orderCycle
Definido se o comando estiver aberto ( OPEN , transação autorizada), ou fechado ( CLOSED , não pode mais ser modificado).
orderCycle toma o valor CLOSED quando este não puder mais ser modificado:
- Quando o pedido é pago totalmente
- Quando o limite de tentativas permitidas for alcançado
Caso contrário, o orderCycle assume o valor OPEN
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| OPEN | A ordem está em andamento. Você deve manter o carrinho de compras, já que outras tentativas de pagamento podem ser feitas. |
| CLOSED | O pedido ou é totalmente pago ou a última tentativa foi recusada (neste caso você precisa gerar um novo formToken ). |
Formato
Caso de uso OPEN
Por default, um comprador tem 4 tentativas para pagar seu pedido. Enquanto todas estas tentativas não foram realizadas, orderCycle está definido em OPEN.
Um pedido pode também ser pago através de mais de uma transação ou com mais de um meio de pagamento. Enquanto a totalidade do pedido não for pago, orderCycle está definido como OPEN.
Se a transação associada estiver em validação manual, orderCycle estará definido com o parâmetro OPEN.
Caso de usos CLOSED
Se a totalidade do pedido for pago, orderCycle está definido como CLOSED.
Quando o pedido expira, orderCycle é definido como CLOSED.
Se todas as tentativas autorizadas falharam (4 por default), orderCycle está definido com CLOSED.
Se a transação for inicialmente criada em validação manual orderCycle será definido em CLOSED quando a transação será validada ou cancelada.
shopId
Código de identificação da loja.
Formato
orderEffectiveAmount
Caminho: orderDetails.orderEffectiveAmount
Valor original da transação em caso de conversão cambial.
Formato
orderDetails.mode
Permite definir o modo que foi usado para criar o pedido.
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| TEST | para um pedido de teste |
| PRODUCTION | Para um pedido real. |
Formato
orderCurrency
Caminho: orderDetails.orderCurrency
Código da moeda do pedido, no formato 4217 alpha-3.
Exemplo: "EUR” para o euro.
Formato
orderDetails.orderId
Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.
Formato
orderTotalAmount
Caminho: orderDetails.orderTotalAmount
Valor total do pedido expresso na sua menor unidade monetária (o centavo para o euro).
Exemplo: 30050 para 300,50 EUR.
Formato
customer.reference
Código de identificação do comprado para o Estabelecimento Comercial.
Formato
customer.email
Endereço e-mail do comprador.
- Especificações de estrutura de e-mail: RFC-2822
Formato
address
Caminho: customer.billingDetails.address
Endereço de faturamento.
Advertência: Os símbolos > e < não são autorizados.
Formato
address2
Caminho: customer.billingDetails.address2
Informações complementares sobre o endereço de faturamento.
Advertência: Os símbolos > e < não são autorizados.
Formato
category
Caminho: customer.billingDetails.category
Tipo de cliente.
Formato
Valores possíveis
| valores | Descrição |
|---|---|
| PRIVATE | Cliente de tipo Pessoa física |
| COMPANY | Cliente de tipo Pessoa Jurídica |
cellPhoneNumber
Caminho: customer.billingDetails.cellPhoneNumber
Telefone mobile do comprador.
Aceita todos os formatos:
Exemplos:
0623456789 +33623456789 0033623456789 (+34) 824 65 43 21 87 77 12 34
Formato
city
Caminho: customer.billingDetails.city
Cidade de faturamento.
Formato
country
Caminho: customer.billingDetails.country
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 |
district
Caminho: customer.billingDetails.district
Bairro do endereço de faturamento.
Formato
firstName
Caminho: customer.billingDetails.firstName
Nome do comprador.
Formato
identityCode
Caminho: customer.billingDetails.identityCode
CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.
Formato
identityType
Caminho: customer.billingDetails.identityType
Tipo de documento de identidade.
Formato
language
Caminho: customer.billingDetails.language
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 |
lastName
Caminho: customer.billingDetails.lastName
Sobrenome do comprador.
Formato
legalName
Caminho: customer.billingDetails.legalName
Razão social.
Formato
phoneNumber
Caminho: customer.billingDetails.phoneNumber
Número de telefone do comprador.
Aceita todos os formatos:
Exemplos:
0123456789 +33123456789 0033123456789 - (00.571) 638.14.00
40 41 42 42
Formato
state
Caminho: customer.billingDetails.state
Região (estado) do endereço de faturamento. Recomendado mas não obrigatório passar o valor em ISO-3166-2.
Formato
streetNumber
Caminho: customer.billingDetails.streetNumber
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
title
Caminho: customer.billingDetails.title
Estado civil do comprador.
Exemplos:
- Sr.
- Sr.
- Sra.
Formato
zipCode
Caminho: customer.billingDetails.zipCode
CEP do endereço de faturamento.
Formato
address
Caminho: customer.shippingDetails.address
Endereço de entrega.
Advertência: Os símbolos > e < não são autorizados.
Formato
address2
Caminho: customer.shippingDetails.address2
Segunda linha do endereço de entrega.
Advertência: Os símbolos > e < não são autorizados.
Formato
category
Caminho: customer.shippingDetails.category
Tipo de cliente.
Formato
Valores possíveis
| valores | Descrição |
|---|---|
| PRIVATE | Cliente de tipo Pessoa física |
| COMPANY | Cliente de tipo Pessoa Jurídica |
city
Caminho: customer.shippingDetails.city
Cidade de entrega.
Formato
country
Caminho: customer.shippingDetails.country
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 |
deliveryCompanyName
Caminho: customer.shippingDetails.deliveryCompanyName
Nome da empresa que entrega o produto.
Formato
district
Caminho: customer.shippingDetails.district
Bairro do endereço de faturamento.
Formato
firstName
Caminho: customer.shippingDetails.firstName
Nome do destinatário.
Formato
identityCode
Caminho: customer.shippingDetails.identityCode
CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.
Formato
lastName
Caminho: customer.shippingDetails.lastName
Sobrenome do comprador.
Formato
legalName
Caminho: customer.shippingDetails.legalName
Razão social para uma entrega em uma empresa.
Formato
phoneNumber
Caminho: customer.shippingDetails.phoneNumber
Número de telefone do comprador.
Aceita todos os formatos:
Exemplos:
0123456789 +33123456789 0033123456789 - (00.571) 638.14.00
40 41 42 42
Formato
shippingMethod
Caminho: customer.shippingDetails.shippingMethod
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. |
shippingSpeed
Caminho: customer.shippingDetails.shippingSpeed
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) |
state
Caminho: customer.shippingDetails.state
Região do endereço de faturamento.
Formato
streetNumber
Caminho: customer.shippingDetails.streetNumber
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
zipCode
Caminho: customer.shippingDetails.zipCode
CEP do endereço de faturamento.
Formato
ipAddress
Caminho: customer.extraDetails.ipAddress
Endereço IP do comprador.
Formato
fingerPrintId
Caminho: customer.extraDetails.fingerPrintId
Formato
browserUserAgent
Caminho: customer.extraDetails.browserUserAgent
Header « User-Agent » do navegador do comprador (HTTP/1.1 - RFC. 2616).
Formato
browserAccept
Caminho: customer.extraDetails.browserAccept
Header « Accept » do navegador do comprador (HTTP/1.1 - RFC. 2616).
Formato
insuranceAmount
Caminho: customer.shoppingCart.insuranceAmount
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
shippingAmount
Caminho: customer.shoppingCart.shippingAmount
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
taxAmount
Caminho: customer.shoppingCart.taxAmount
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
cartItemInfo
Caminho: customer.shoppingCart.cartItemInfo
cardItemInfo é uma lista de objetos Customer/ShoppingCartItemInfo.
Permite descrever cada artigo do carrinho.
Formato
productAmount
Caminho: customer.shoppingCart.cartItemInfo.productAmount
Valor do produto expresso na sua menor unidade monetária (o centavo para o Euro).
Exemplo: 30050 para 300,50 EUR.
Formato
productLabel
Caminho: customer.shoppingCart.cartItemInfo.productLabel
Nome do produto.
Formato
productQty
Caminho: customer.shoppingCart.cartItemInfo.productQty
Quantidade de produto.
Formato
productRef
Caminho: customer.shoppingCart.cartItemInfo.productRef
Referência produto.
Formato
productType
Caminho: customer.shoppingCart.cartItemInfo.productType
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
productVat
Caminho: customer.shoppingCart.cartItemInfo.productVat
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
companyType
Caminho: subMerchantDetails.companyType
Tipo de empresa do revendedor. Enviado pelo facilitador de pagamento.
Dependendo do adquirente, podem ser aplicadas regras diferentes. Este campo é frequentemente usado para especificar o tipo de Legal Number do comprador.
Formato
legalNumber
Caminho: subMerchantDetails.legalNumber
CNPJ do revendedor de acordo com o campo companyType. Enviado pelo facilitador de pagamento.
Formato
name
Caminho: subMerchantDetails.name
Razão social do revendedor. Enviado pelo facilitador de pagamento.
Formato
url
Caminho: subMerchantDetails.url
URL do revendedor. Enviado pelo facilitador de pagamento.
Formato
phoneNumber
Caminho: subMerchantDetails.phoneNumber
Número de telefone do revendedor. Enviado pelo facilitador de pagamento.
Formato
address1
Caminho: subMerchantDetails.address1
Endereço do revendedor. Enviado pelo facilitador de pagamento.
Formato
address2
Caminho: subMerchantDetails.address2
Complemento do endereço do revendedor. Enviado pelo facilitador de pagamento.
Formato
zip
Caminho: subMerchantDetails.zip
CEP do revendedor. Enviado pelo facilitador de pagamento.
Formato
city
Caminho: subMerchantDetails.city
Cidade do revendedor. Enviado pelo facilitador de pagamento.
Formato
country
Caminho: subMerchantDetails.country
Código país do endereço do revendedor (norma ISO 3166 alfa-2). Enviado pelo facilitador de pagamento.
Formato
mcc
Caminho: subMerchantDetails.mcc
Código MCC do revendedor. Enviado pelo facilitador de pagamento.
Formato
mid
Caminho: subMerchantDetails.mid
Número de contrato (MID) do revendedor. Enviado pelo facilitador de pagamento.
Formato
softDescriptor
Caminho: subMerchantDetails.softDescriptor
Denominação (soft-descriptor) do revendedor que aparece no extrato bancário do comprador. Enviado pelo facilitador de pagamento.
Formato
state
Caminho: subMerchantDetails.state
Região do endereço do revendedor. Enviado pelo facilitador de pagamento.
Formato
facilitatorId
Caminho: subMerchantDetails.facilitatorId
Identificador do facilitador de pagamento. Enviado pelo facilitador de pagamento.
Formato
transactions.amount
Montante da transação na menor unidade monetária (centavo para o Real). Ex: 1234 para 12,34 BRL.
Exemplo: 30050 para 300,50 EUR.
Formato
creationDate
Caminho: transactions.creationDate
Data e hora de registro da transação.
Formato
currency
Caminho: transactions.currency
Moeda do pagamento. Código alfabético em maiúsculas de acordo com ISO 4217 alfa-3.
Exemplo: "EUR” para o euro.
Formato
Valores possíveis
Os valores possíveis são os seguintes:
| Moeda | CODIFICAÇÃO ISO 4217 | Unidade fracionária |
|---|---|---|
| Dólar australiano (036) | AUD | 2 |
| Dólar canadense (124) | CAD | 2 |
| Franco suíço (756) | CHF | 2 |
| Coroa dinamarquesa (208) | DKK | 2 |
| Euro (978) | EUR | 2 |
| Libra Esterlingo (826) | GBP | 2 |
| Iene japonês (392) | JPY | 0 |
| Coroa norueguesa (578) | NOK | 2 |
| Coroa sueca (752) | SEK | 2 |
| Dólar dos Estados-Unidos (840) | USD | 2 |
detailedErrorCode
Caminho: transactions.detailedErrorCode
Código de erro detalhado retornado pelo adquirente, sem filtros ou alterações.
Ver Lista dos códigos retorno autorização para maiores detalhes.
Formato
detailedErrorMessage
Caminho: transactions.detailedErrorMessage
Mensagem de erro detalhada retornada pela aplicação de pagamento sem filtro.
Contem informações contextuais para ajudar a entender o erro.
Este campo pode ser valorizado a null quando errorCode for ACQ_001.
Consulte a descrição do campo detailedErrorCode para saber por qual razão a autorização foi recusada.
Formato
detailedStatus
Caminho: transactions.detailedStatus
O parâmetro detailedStatus fornece informações detalhadas sobre o status do pagamento. Cada um dos status é restrito ao meio de pagamento usado.
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| ACCEPTED | Status de uma transação de tipo VERIFICATION cuja autorização ou solicitação de informação foi aceita. Este status não pode evoluir. As transações com o status “ACCEPTED” nunca são capturadas no banco. Uma transação de tipo VERIFICATION é criada quando atualizar ou criar um Token sem pagamento. |
| AUTHORISED | O valor é autorizado e vai ser capturado automaticamente. |
| AUTHORISED_TO_VALIDATE | A transação, criada em validação manual, está autorizada. O Estabelecimento Comercial deve validar manualmente a transação para lançar a solicitação de autorização e a captura no banco. Pode-se validar a transação enquanto a data de vencimento da solicitação de autorização não for ultrapassada. Se esta data está vencida, então o pagamento tem o status EXPIRED. O status Vencido é definitivo. |
| CANCELLED | A transação foi cancelada. |
| CAPTURED | O valor da transação foi capturado. |
| CAPTURE_FAILED | A captura da transação falhou. Entrar em contato com o Suporte. |
| EXPIRED | A data de vencimento da solicitação de autorização foi atingida e o Estabelecimento Comercial não validou a transação Portanto, o portador não será debitado. |
| INITIAL | Este status é temporário. É retornado se nenhuma resposta for recebida do adquirente ou o prazo de resposta do 'adquirente ultrapassa o tempo da sessão do pagamento na plataforma de pagamento. |
| PENDING | Reembolso : O reembolso está em andamento . Marketplace : O pagamento foi feito com sucesso. A ou as transações correspondentes são criadas e com captura em andamento, ou eventualmente à espera de uma validação manual. |
| PRE_AUTHORISED | Status de uma transação de tipo PRE_AUTHORISATION cuja autorização foi aceita. Este status não pode evoluir. As transações com o status “PRE_AUTHORISED” nunca são capturadas no banco. |
| REFUSED | A transação foi recusada. |
| UNDER_VERIFICATION | Verificações em andamento pelo adquirente Este status não é definitivo. |
| WAITING_AUTHORISATION | O prazo de captura no banco é maior que o tempo de validade da autorização. |
| WAITING_AUTHORISATION_TO_VALIDATE | O meio de pagamento foi verificado mas a transação ainda não foi autorizada porque o prazo de captura é superior ao prazo de validade da autorização A solicitação de autorização será inciada automaticamente em D-1 antes da data de captura no banco. Uma intervenção manual será necessária para confirmar a autorização Nada garante que a solicitação de autorização seja aceita. |
| WAITING_FOR_PAYMENT | Transação com pagamento em andamento Este status não é definitivo. |
| ERROR | Ocorreu um erro não esperado. |
Para maiores detalhes sobre o ciclo de vida de uma transação, consultar: Ciclo de vida das transações
Formato
Para maiores detalhes sobre o ciclo de vida de uma transação, consultar: Ciclo de vida das transações
Formato
effectiveStrongAuthentication
Caminho: transactions.effectiveStrongAuthentication
Indica se o portador se identificou com sucesso durante o pagamento.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| ENABLED | A autenticação do portador foi realizada com sucesso. |
| DISABLED | O pagamento não é sujeito a uma autenticação do portador ou a autenticação do portador não foi realizada com sucesso. |
Formato
errorCode
Caminho: transactions.errorCode
Código de erro. Ver Códigos de erro para maiores detalhes.
Formato
errorMessage
Caminho: transactions.errorMessage
Mensagem de erro. Ver Códigos de erro para maiores detalhes.
Formato
metadata
Caminho: transactions.metadata
Valores personalizados vinculados à transação, no formato json.
Exemplo de chamada:
Por exemplo, para passar um valor personalizado, adicione a sua solicitação:
{
"metadata": {
"MyValueKey": "1234"
}
}Esse valor é retornado no objeto da transação recém-criada.
Pode também usar os metadatas " orderInfo1 ", " orderInfo2 " e " orderInfo3 ”para enviar informações adicionais sobre o pedido.
Estes dados serão depois exibidos na aba Extra do detalhe da transação no seu
Formato
operationType
Caminho: transactions.operationType
Tipo de operação.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| DEBIT | Operação de débito |
| CREDIT | Operação de reembolso |
| VERIFICATION | Operação de verificação de meio de pagamento |
Formato
transactions.uuid
Referência única da transação gerada pela plataforma de pagamento.
Formato
paymentMethodToken
Caminho: transactions.paymentMethodToken
Token associado a um meio de pagamento.
Formato
paymentMethodType
Caminho: transactions.paymentMethodType
Tipo de meio de pagamento. Exemplo: PAYCONIQ
Formato
shopId
Código de identificação da loja.
Formato
transactions.status
Status simplificado da transação. É o mesmo para todos os meios de pagamento. Permite implementar um código genérico compatível com todos os meios de pagamentos.
Todo meio de pagamento também possui status dedicados, ver a propriedade detailedStatus para maiores detalhes.
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| PAID | A transação foi paga. |
| UNPAID | A transação não foi paga. |
| RUNNING | Transação em andamento |
| PARTIALLY_PAID | A transação foi parcialmente paga |
Para maiores detalhes sobre o ciclo de vida de uma transação, consultar: Ciclo de vida das transações
Formato
liabilityShift
Caminho: transactions.transactionDetails.liabilityShift
Definido se o pagamento é possível.
Valores possíveis
Os valores possíveis são os seguintes:
| valores | Descrição |
|---|---|
| YES | o pagamento é garantido. |
| NO | o pagamento não é garantido |
| nulle | o pagamento não é garantido |
Formato
mid
Caminho: transactions.transactionDetails.mid
Número de contrato Estabelecimento Comercial. Se este campo é informado, tomar cuidado em utilizar o contrato certo em relação à rede do cartão.
Formato
effectiveAmount
Caminho: transactions.transactionDetails.effectiveAmount
Valor original da transação em caso de conversão cambial.
Formato
sequenceNumber
Caminho: transactions.transactionDetails.sequenceNumber
Número de sequência da transação.
Formato
effectiveCurrency
Caminho: transactions.transactionDetails.effectiveCurrency
Moeda original da transação em caso de conversão cambial.
Formato
creationContext
Caminho: transactions.transactionDetails.creationContext
Apresenta o processo que iniciou a transação.
Valores possíveis
Os valores possíveis são os seguintes:
| valores | Descrição |
|---|---|
| CHARGE | Para uma solicitação de débito. |
| REFUND | Para uma solicitação de crédito. |
Formato
parentTransactionUuid
Caminho: transactions.transactionDetails.parentTransactionUuid
UUID da transação fonte.
Formato
paymentSource
Caminho: transactions.transactionDetails.cardDetails.paymentSource
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 |
| Absent ou null | O valor por default é "EC". |
manualValidation
Caminho: transactions.transactionDetails.cardDetails.manualValidation
Modo de validação da transação.
Formato
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| NO | Validação automática pela plataforma de pagamento. |
| YES | Validação manual pelo Estabelecimento Comercial. |
| null | Configuração padrão da loja escolhida (pode ser configurado no |
expectedCaptureDate
Caminho: transactions.transactionDetails.cardDetails.expectedCaptureDate
Data da captura no banco apresentada no formato ISO 8601 definido pelo W3C.
Formato
effectiveBrand
Caminho: transactions.transactionDetails.cardDetails.effectiveBrand
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 |
Formato
pan
Caminho: transactions.transactionDetails.cardDetails.pan
Número de cartão truncado.
Formato
expiryMonth
Caminho: transactions.transactionDetails.cardDetails.expiryMonth
Mês de vencimento com 2 dígitos. Exemplo: "09" para setembro.
Formato
expiryYear
Caminho: transactions.transactionDetails.cardDetails.expiryYear
Ano de vencimento com 2 dígitos. Exemplo: "25" para 2025.
Formato
country
Caminho: transactions.transactionDetails.cardDetails.country
Código país do cartão.
Formato
issuerCode
Caminho: transactions.transactionDetails.cardDetails.issuerCode
Código banco associado ao banco emissor.
Formato
issuerName
Caminho: transactions.transactionDetails.cardDetails.issuerName
Nome do banco associado ao banco emissor.
Formato
effectiveProductCode
Caminho: transactions.transactionDetails.cardDetails.effectiveProductCode
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 |
| Visa Signature Business | |
| Reserved | |
| Visa Business Enhanced | |
| Visa Infinite Business | |
| Visa Business Rewards | |
| H | Reserved |
| I | Visa Infinite |
| Visa Infinite Privilege | |
| Visa Ultra High Net Worth | |
| J | Reserved |
| Reserved | |
| Reserved | |
| Visa Healthcare | |
| Reserved | |
| K | Visa Corporate T&E |
| Visa GSA Corporate T&E | |
| L | Electron |
| N | Visa Platinium |
| TBA | |
| Visa Select | |
| P | Visa Gold |
| Q | Private Label |
| Reserved | |
| Private Label Basic | |
| Private Label Standard | |
| Private Label Enhanced | |
| Private Label Specialized | |
| Private Label Premium | |
| R | Proprietary |
| S | Visa Purchasing |
| Visa Purchasing | |
| Visa Purchasing | |
| Visa Purchasing | |
| Government Services Loan | |
| Commercial Transport EBT | |
| Business Loan | |
| 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 |
| 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
paymentMethodSource
Caminho: transactions.transactionDetails.cardDetails.paymentMethodSource
Permite caracterizar o modo de meio de pagamento usado.
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| NEW | Transação criada a partir de um novo meio de pagamento. |
| TOKEN | Transação criada a partir de um meio de pagamento já existente. |
Formato
legacyTransId
Caminho: transactions.transactionDetails.cardDetails.legacyTransId
Código da transação de 6 símbolos.
Formato
cardHolderName
Caminho: transactions.transactionDetails.cardDetails.cardHolderName
Sobrenome e nome do portador do cartão
Formato
identityDocumentType
Caminho: transactions.transactionDetails.cardDetails.identityDocumentType
Tipo de documento de identidade.
Formato
identityDocumentNumber
Caminho: transactions.transactionDetails.cardDetails.identityDocumentNumber
Número de RG do comprador.
O formato depende do tipo de documento de identidade: de 7 a 13 caracteres, números, letras e/ou pontos.
Na América Latina, este parâmetro pode ser obrigatório para certos adquirentes.
Formato
legacyTransDate
Caminho: transactions.transactionDetails.cardDetails.legacyTransDate
Data e hora de recepção da solicitação de pagamento. Usado para encontrar as transações id antigo formato.
Formato
productCategory
Caminho: transactions.transactionDetails.cardDetails.productCategory
Categoria do produto do cartão.
O valor é procedente dos arquivos de classificação BIN.
Valores possíveis
| VALOR | Descrição |
|---|---|
| CREDIT | Cartão de crédito |
| DEBIT | Cartão de débito |
| PREPAID | Cartão pré-pago |
Formato
nature
Caminho: transactions.transactionDetails.cardDetails.nature
Natureza do cartão.
Campo vazio se não apresentado pelo adquirente.
Valores possíveis
| VALOR | Descrição |
|---|---|
| CONSUMER_CARD | Cartão consumidor |
| COMMERCIAL_CARD | Cartão corporativo |
Formato
amount
Caminho: transactions.transactionDetails.cardDetails.authorizationResponse.amount
Valor da autorização.
Formato
currency
Caminho: transactions.transactionDetails.cardDetails.authorizationResponse.currency
Código da moeda usada na solicitação de autorização.
Formato
authorizationDate
Caminho: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationDate
Data e hora da solicitação de autorização.
Formato
authorizationNumber
Caminho: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationNumber
Número da solicitação de autorização.
Formato
authorizationResult
Caminho: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationResult
Código retorno da solicitação de autorização.
Ver Lista dos códigos retorno autorização para maiores detalhes.
Formato
authorizationMode
Caminho: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationMode
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
amount
Caminho: transactions.transactionDetails.cardDetails.markAuthorizationResponse.amount
Valor da pré-autorização.
Formato
currency
Caminho: transactions.transactionDetails.cardDetails.markAuthorizationResponse.currency
Código da moeda usada na solicitação de pré-autorização.
Formato
authorizationDate
Caminho: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationDate
Data e hora da solicitação de pré-autorização.
Formato
authorizationNumber
Caminho: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationNumber
Número da solicitação de pré-autorização.
Formato
authorizationResult
Caminho: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationResult
Código retorno da solicitação de pré-autorização.
Formato
captureDate
Caminho: transactions.transactionDetails.cardDetails.captureResponse.captureDate
Data e hora de captura.
Formato
captureFileNumber
Caminho: transactions.transactionDetails.cardDetails.captureResponse.captureFileNumber
Número de captura.
Formato
refundAmount
Caminho: transactions.transactionDetails.cardDetails.captureResponse.refundAmount
Valor reembolsado.
Formato
refundCurrency
Caminho: transactions.transactionDetails.cardDetails.captureResponse.refundCurrency
Moeda do valor reembolsado.
Formato
effectiveRefundAmount
Caminho: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundAmount
Formato
effectiveRefundCurrency
Caminho: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundCurrency
Formato
transactionCondition
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.transactionCondition
Status da autenticação 3D Secure.
Valores possíveis
Status de autenticação do portador.
| VALOR | Descrição |
|---|---|
| COND_3D_SUCCESS | Sucesso da autenticação. O Estabelecimento Comercial e o portador do cartão estão inscritos ao programa 3D Secure e o portador autenticou-se corretamente. |
| COND_3D_FAILURE | Autenticação não sucedida. O Estabelecimento Comercial e o portador do cartão estão inscritos ao programa 3D Secure mas o comprador não conseguiu autenticar-se (senha errada). |
| COND_3D_ERROR | Autenticação em falha. O Estabelecimento Comercial participa ao programa 3D secure mas o servidor da plataforma de pagamento encontrou um problema técnico durante o processo de autenticação (quando verificou a inscrição do cartão ao programa 3D ou durante a autenticação do portador). |
| COND_3D_NOTENROLLED | Portador não inscrito. O Estabelecimento Comercial participa ao programa 3D Secure mas o cartão do portador não é inscrito. |
| COND_3D_ATTEMPT | Tentativa de autenticação. O Estabelecimento Comercial e o portador do cartão estão inscritos ao programa 3D Secure mas o comprador não teve que autenticar-se (o servidor de controle de acesso do banco que emitiu o cartão somente implementa a geração de um comprovante de tentativa de autenticação). |
| COND_SSL | 3D Secure não aplicável. Estabelecimento Comercial não inscrito ao 3D Secure ou o canal de venda não tem cobertura com esta garantia. |
Formato
enrolled
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.enrolled
Status de alistamento do portador.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| YES | Portador inscrito, autenticação 3D Secure possível. Observação: No Back Office, o valor ENROLLED é exibido (aba 3D Secure do Detalhes de uma transação). |
| NO | Portador não inscrito. Observação: No Back Office, o valor NOT_ENROLLED é exibido (aba 3D Secure do Detalhes de uma transação). |
| UNKNOWN | Não foi possível verificar o status de inscrição. Observação: No Back Office, o valor UNAVAILABLE é exibido (aba 3D Secure do Detalhes de uma transação). |
Formato
status
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.status
Status de autenticação do portador.
Valores possíveis
Status de autenticação do portador.
| VALOR | Descrição |
|---|---|
| YES | Autenticação sucedida. Observação: No Back Office, o valor SUCCESS é exibido (aba 3D Secure do Detalhes de uma transação). |
| NO | Erro de autenticação. Observação: No Back Office, o valor FAILED é exibido (aba 3D Secure do Detalhes de uma transação). |
| UNKNOWN | Autenticação impossível. Observação: No Back Office, o valor UNAVAILABLE é exibido (aba 3D Secure do Detalhes de uma transação). |
| ATTEMPT | Tentativa de autenticação. Observação: No Back Office, o valor ATTEMPT é exibido (aba 3D Secure do Detalhes de uma transação). |
Formato
eci
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.eci
Indicador de Comercio Eletrônico.
Valores possíveis
O valor eci depende do status da autenticação 3DS e do tipo de cartão. Os valores possíveis são:
| TIPO DE CARTÃO | STATUS=Y | STATUS=A | STATUS=U | STATUS=N |
|---|---|---|---|---|
| VISA - AMEX | 5 | 6 | 7 | - |
| MasterCard | 02 | 01 | - | - |
Formato
xid
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.xid
Código único da transação.
Formato
cavvAlgorithm
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavvAlgorithm
Algoritmo de verificação da autenticação do portador.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| HMAC | HMAC |
| CVV | Card Verification Value |
| CVV_ATN | CVV Authentication Tracking Number |
| SPA | MasterCard SPA Algorithm. |
| A | AV-CB |
Formato
cavv
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavv
Cardholder Authentication Verification Value.
Formato
signValid
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.signValid
Validade da assinatura da mensagem PARes.
Valores possíveis
Status de autenticação do portador.
| VALOR | Descrição |
|---|---|
| nulle | Sem 3DS. |
| 0 | Assinatura incorreta. |
| 1 | Assinatura correta. |
Formato
brand
Caminho: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.brand
Rede do cartão.
Formato
id
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.id
token único de autenticação, no formato UUID.
Formato
operationSessionId
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.operationSessionId
Código único da sessão de autenticação.
Formato
instructionType
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.instructionType
Tipo da instrução para ser realizada.
Formato
Valores possíveis
| valores | Descrição |
|---|---|
| FORM | Instrução de tipo redirecionamento por formulário |
name
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.name
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
_type
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value._type
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
timeout
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.timeout
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
method
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.method
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
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.url
Url para qual apresentar o formulário http.
Formato
body
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.body
Lista dos parâmetros do corpo da solicitação, sob a forma “nome”: “valor”.
Formato
headers
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.headers
Lista dos cabeçalhos da solicitação http, sob a forma de “nome”: “valor”
Formato
element
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.element
Tipo de elemento alvo html no qual deverá ser materializado a instrução.
Valores possíveis
| VALOR | Descrição |
|---|---|
| IFRAME |
Formato
height
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.height
Altura do alvo html em pixeis.
Formato
visible
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.visible
Boolean que indica se o alvo html deve ser visível ou não.
Formato
width
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.width
Largura do alvo html em pixeis.
Formato
showUrl
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.showUrl
Campo técnico de uso interno, que permite exibir ou ocultar a URL do ACS.
Formato
challengePreference
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.challengePreference
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
name
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.name
Nome do protocolo de autenticação do portador do cartão.
Valores possíveis
| VALOR | Descrição |
|---|---|
| THREEDS | Protocolo 3D Secure |
Formato
simulation
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.simulation
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
network
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.network
Rede na qual o cartão foi autenticado.
Redes atualmente suportadas
| VALOR |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| PROTECTBUY |
Formato
version
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.version
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
authenticationType
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationType
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
commerceIndicator
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.commerceIndicator
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 |
|---|---|
| Not authenticated | |
| Authenticated |
Formato
status
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.status
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
authenticationIdType
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.authenticationIdType
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
value
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.value
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) | chaine / 32 caractères alphanumériques + 4 tirets | 4317fdc3-ad24-5443-8000-000000000891 |
Formato
authenticationValueType
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.authenticationValueType
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
value
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.value
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
authenticationType
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.authenticationType
Tipo da extensão de resultado.
Formato
Valores possíveis
| valores | Descrição |
|---|---|
| THREEDS_V2 | Extensão para as autenticações 3DS Secure v2 |
acsTransId
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.acsTransId
ID da transação ACS. Este campo é relevante apenas para a rede CB . Consulte: Guia de Integração
Formato
cbScore
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.cbScore
Score CB como definido na extensão CB da mensagem ARES.
Formato
algorithm
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.algorithm
Código do algoritmo usado para gerar o Valor de Autenticação (usado durante a autorização)
Valores possíveis
| VALOR | Descrição |
|---|---|
| 0 | |
| 1 | |
| 2 | CVV com ATN |
| 3 | MasterCard SPA |
Formato
code
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.code
Código adicional informativo sobre a origem do resultado. Ex: DS_TIMEOUT.
Formato
message
Caminho: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.message
Mensagem adicional informativa sobre a origem do resultado.
Formato
installmentNumber
Caminho: transactions.transactionDetails.cardDetails.installmentNumber
Quantidade de parcelas.
Formato
installmentCode
Caminho: transactions.transactionDetails.cardDetails.installmentCode
Código da opção de pagamento usada para o pagamento.
Formato
subscriptionId
Caminho: transactions.transactionDetails.subscriptionDetails.subscriptionId
Código de identificação da assinatura.
Formato
name
Caminho: transactions.transactionDetails.fraudManagement.riskControl.name
Nome do controle implementado para o gerenciamento de riscos.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| CARD_FRAUD | Controla a presença do número de cartão do comprador na lista cinza de cartões. |
| SUSPECT_COUNTRY | Controla a presença do país emissor do cartão do comprador na lista dos países proibidos. |
| IP_FRAUD | Controla a presença do endereço IP do comprador na lista cinza de IP. |
| CREDIT_LIMIT | Controla a freqüência e os valores de compra de um mesmo número de cartão, ou o valor máximo de um pedido. |
| BIN_FRAUD | Controla a presença do código BIN do cartão do comprador na lista cinza de códigos BIN. |
| ECB | Controla se o cartão do comprador é do tipo e-Carte Bleue. |
| COMMERCIAL_CARD | Controla se o cartão do comprador for um cartão comercial. |
| SYSTEMATIC_AUTO | Controla se o cartão do comprador for um cartão com autorização sistemática. |
| INCONSISTENT_COUNTRIES | Controla se o país do endereço IP, o país emissor do cartão de pagamento, e o país do endereço do comprador são coerentes entre eles. |
| NON_WARRANTY_PAYMENT | Controla a transferência de responsabilidade da transação. |
| SUSPECT_IP_COUNTRY | Controla a presença do país do comprador, identificado por seu endereço IP, na lista de países proibidos. |
Formato
result
Caminho: transactions.transactionDetails.fraudManagement.riskControl.result
Nome do controle implementado para o gerenciamento de riscos.
Valores possíveis
Resultado do controle de risco.
| VALOR | Descrição |
|---|---|
| OK | |
| WARNING | Controle informativo não sucedido. |
| ERROR | Controle bloqueante não sucedido. |
Formato
score
Caminho: transactions.transactionDetails.fraudManagement.riskAnalysis.score
Código da análise para o analisador de risco.
Formato
resultCode
Caminho: transactions.transactionDetails.fraudManagement.riskAnalysis.resultCode
Código retornado por um analista de risco externo.
Valores possíveis
Os valores possíveis são os seguintes:
| Descrição | |
|---|---|
| INVALID_CREDENCIAL | Falha de configuração do contrato de análise de riscos. |
| COMUNICATION_PROBLEM | Não foi possível conectar com o analisador de riscos. |
| DATA_PROCESSING_PROBLEM | Falha durante o tratamento do envio ou da resposta do analisador de riscos. |
| MISSING_MANDATORY_ORDER_INFO | Dados relativos ao pedido estão faltando. |
| MISSING_MANDATORY_SHIPPING_INFO | Dados relativos à entrega estão faltando. |
| MISSING_MANDATORY_SHIPPING_ADDRESS_INFO | Dados relativos ao endereço de entrega estão faltando. |
| MISSING_MANDATORY_BILLING_INFO | Dados relativos ao faturamento estão faltando. |
| MISSING_MANDATORY_BILLING_ADDRESS_INFO | Dados relativos ao endereço de faturamento estão faltando. |
| MISSING_MANDATORY_CARD_INFO | Dados sobre o meio de pagamento estão faltando. |
| MISSING_MANDATORY_CUSTOMER_INFO | Dados sobre o comprador estão faltando. |
| APA | Específico ClearSale. A transação está automaticamente aprovada conforme as configurações. |
| APM | Específico ClearSale. A transação foi manualmente aprovada por um analista. |
| RPM | Específico ClearSale. O pedido foi recusado devido a uma falta de informações sobre o comprador conforme à política aplicada. |
| AMA | Específico ClearSale. Análise manual em espera. O pedido está na fila de espera para análise. |
| ERR | Específico ClearSale. Erro. |
| NVO | Específico ClearSale. Novo pedido. Tratamento e classificação em andamento. |
| SUS | Específico ClearSale. Pedido manualmente suspenso. O pedido está suspenso por suspeita de fraude. |
| CAN | Específico ClearSale. Pedido cancelado. O pedido foi cancelado pelo comprador. |
| FRD | Específico ClearSale. Fraude confirmada com o operador do cartão de crédito ou o titular do cartão. |
| RPA | Específico ClearSale. Pedido recusado automaticamente. O pedido foi recusado conforme às configurações da análise de fraude externa. |
| RPP | Específico ClearSale. Pedido recusado automaticamente. O pedido foi recusado conforme à aplicação da política cliente ou ClearSale. |
| 100 | Específico CyberSource. A transação foi realizada com sucesso. |
| 101 | Específico CyberSource. A transação foi recusada. Um ou mais campos estão faltando. |
| 102 | Específico CyberSource. A transação foi recusada. Um ou mais campos contém dados inválidos. |
| 150 | Específico CyberSource. Erro. |
| 151 | Específico CyberSource. Erro. A solicitação foi recebida mas o prazo foi excedido. Este erro não inclui prazos excedidos entre o cliente e o servidor. |
| 152 | Específico CyberSource. Erro. A solicitação foi recebida mas um serviço não foi concluído dentro do prazo. |
| 202 | Específico CyberSource. Recusada. Cartão vencido. |
| 231 | Específico CyberSource. Recusada. Número de conta inválido. |
| 234 | Específico CyberSource. Recusado. Um problema ocorreu com a configuração CyberSource do Estabelecimento Comercial. |
| 400 | Específico CyberSource. Recusada. O valor da fraude excede o limiar de tolerância. |
| 480 | Específico CyberSource. O pedido está marcado para ser examinado pelo Decision Manager. |
| 481 | Específico CyberSource. O pedido foi recusado pelo Decision Manager. |
| APPROVE | Específico Konduto. Konduto recomenda aceitar a transação. Se nenhuma regra contradizer esta recomendação, o status da transação será AUTHORISED. |
| DECLINE | Específico Konduto. Konduto recomenda recusar a transação. O status da transação será REFUSED. |
| REVIEW | Específico Konduto. Konduto recomenta conferir a transação. Dependendo do resultado da autenticação 3D-Secure, o status da transação será: |
| AUTHORISED_TO_VALIDATE | se a autenticação do portador foi realizada com sucesso. |
| REFUSED | se a autenticação do portador falhar. |
Formato
status
Caminho: transactions.transactionDetails.fraudManagement.riskAnalysis.status
Código retornado por um analista de risco externo.
Status da análise de risco.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| P_SEND_OK | Sucesso.”Sent to clearsale and successfully processed”. |
| P_TO_SEND | O envio está programado. "Transaction analysis is scheduled to be sent to risk analyzer". |
| P_TO_SEND_KO | Erro de processamento. "Problem when tried to send to risk analyzer". |
| P_PENDING_AT_ANALYZER | Atualmente está sendo processado pelo analisador."Analysis result is still being processed by the risk analyzer. We should keep checking/waiting for the analysis result”. |
| P_MANUAL | Envio manual pendente. "Analysis should be requested through user request (not automatically)" |
| P_SKIPPED | Descartado.”Analysis request discarded by current transaction status/problem”. |
| P_SEND_EXPIRED | Vencido.* “Analysis request expired”. |
Formato
requestId
Caminho: transactions.transactionDetails.fraudManagement.riskAnalysis.requestId
Código da análise para o analisador de risco.
Formato
extraInfo
Caminho: transactions.transactionDetails.fraudManagement.riskAnalysis.extraInfo
Específico ao CyberSource. Códigos retornados pelo DecisionManager.
Formato
fingerPrintId
Caminho: transactions.transactionDetails.fraudManagement.riskAnalysis.fingerPrintId
Este campo é usado pelos Estabelecimentos Comerciais que implementam o analisador de risco na página de pagamento deles Permite enviar o login de sessão (ou fingerPrint Id) à plataforma de pagamento para finalizar a análise de risco.
Os analisadores suportados são:
NOTO Cybersource MonitorPlus ClearSale
Pode conter maiúsculas, minúsculas, números e hifens ([A-Z][a-z], 0-9, _, -).
Formato
results
Caminho: transactions.transactionDetails.fraudManagement.riskAssessments.results
Lista das ações realizadas na transação, após o acionamento das regras de gerenciamento de riscos avançados ativadas na loja.
Os valores possíveis dependem das opções da loja.
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| ENABLE_3DS |
|
| DISABLE_3DS |
|
| NO_PREFERENCE |
|
| NO_CHALLENGE_REQUESTED |
|
| CHALLENGE_REQUESTED |
|
| CHALLENGE_MANDATE |
|
| MANUAL_VALIDATION | Transação criada em validação manual. A captura do pagamento está bloqueada temporariamente para permitir ao Estabelecimento Comercial efetuar todas as verificações desejadas. |
| REFUSE | A transação foi recusada. |
| RUN_RISK_ANALYSIS | Chamada para analisador de riscos externos se o Estabelecimento Comercial possuir um contrato. Referir-se à descrição do objeto TransactionDetails.FraudManagement.RiskAnalysis para identificar a lista dos valores possíveis e a descrição deles. |
| INFORM | Um aviso foi enviado. O EC é avisado que um risco foi identificado. O Estabelecimento Comercial é informado via uma ou mais regras do centro de notificação (URL de notificação, e-mail ou SMS). |
Formato
taxRate
Caminho: transactions.transactionDetails.taxRate
Usado por certos meios de pagamento na América Latina. Permite enviar a taxa de impostos aplicada no valor total do pedido O valor deve ser a percentagem a ser aplicada (21 para 21%).
Formato
taxAmount
Caminho: transactions.transactionDetails.taxAmount
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
preTaxAmount
Caminho: transactions.transactionDetails.preTaxAmount
Permite definir o valor sem impostos para a totalidade do pedido.
O valor deve ser expresso na menor unidade da moeda.
Formato
externalTransactionId
Caminho: transactions.transactionDetails.externalTransactionId
Referência externa da transação.
Formato
dccAmount
Caminho: transactions.transactionDetails.dcc.dccAmount
Valor da transação expresso na menor unidade da moeda definida por dccCurrency (o centavo para o euro).
Este campo será avaliado apenas se o cartão for elegível para o serviço de conversão dinâmica de moedas (DCC) e o comprador optar por pagar na moeda do seu cartão.
A taxa de conversão retorna para o campo dccChangeRate.
Formato
dccCurrency
Caminho: transactions.transactionDetails.dcc.dccCurrency
Código numérico (de acordo com a norma ISO 4217) da moeda escolhida pelo comprador quando o cartão é elegível para o serviço de conversão dinâmica de moedas (DCC).
Este campo será avaliado apenas se o cartão for elegível para o serviço de conversão dinâmica de moedas (DCC) e o comprador optar por pagar na moeda do seu cartão.
A taxa de conversão retorna para o campo dccChangeRate.
Formato
dccChangeRate
Caminho: transactions.transactionDetails.dcc.dccChangeRate
Taxa de cambio usada para calcular o valor real do pagamento.
Formato
dccMarkup
Caminho: transactions.transactionDetails.dcc.dccMarkup
Indica a percentagem (ou taxa) de margem comercial sobre o valor total.
Este campo será avaliado apenas se o cartão for elegível para o serviço de conversão dinâmica de moedas (DCC) e o comprador optar por pagar na moeda do seu cartão.
Exemplo: "3.5" para uma margem de 3.5%.
Formato
dccRateDate
Caminho: transactions.transactionDetails.dcc.dccRateDate
Data e hora UTC da obtenção da taxa de conversão junto ao serviço de conversão dinâmica de moeda (DCC).
Este campo será avaliado apenas se o cartão for elegível para o serviço de conversão dinâmica de moedas (DCC) e o comprador optar por pagar na moeda do seu cartão.
A taxa de conversão retorna para o campo dccChangeRate.
Formato
paymentReference
Caminho: transactions.transactionDetails.acquirerDetails.paymentReference
Referência do pagamento exibida no cupom de pagamento.
Usado pelo meio de pagamento Multibanco.
Formato
serviceSupplier
Caminho: transactions.transactionDetails.acquirerDetails.serviceSupplier
Código da entidade pela qual o pagamento é realizado.
Usado pelo meio de pagamento Multibanco.
Formato
nsu
Caminho: transactions.transactionDetails.nsu
Número de sequência único (América Latina).
Formato
tid
Caminho: transactions.transactionDetails.tid
Terminal ID. Código da loja definida na afiliação de aprovação.
Este campo é somente usado na Colômbia para escolher entre REDEBAN e CREDIBANCO .
Formato
acquirerNetwork
Caminho: transactions.transactionDetails.acquirerNetwork
Código da rede adquirente.
Valores possíveis:
| Código Rede | Denominação |
|---|---|
| ACCORD | Cartão marca Accord |
| ACCORD_SANDBOX | Cartão marca Accord - Modo sandbox |
| ALMA | ALMA |
| AMEXGLOBAL | American Express International |
| APPLE PAY | Apple Pay |
| AURORE | Cetelem - Cartões de crédito Aurore e Cpay |
| CB | Cartão bancário |
| CONECS | CONECS |
| EDENRED | Edenred Bélgica |
| FRANFINANCE | FRANFINANCE |
| FRANFINANCE_SB | Franfinance - Modo sandbox |
| FULLCB | Cetelem - 3 ou 4 vezes Cartão |
| GATECONEX | Elavon Europa |
| GICC_DINERS | Diners via Concardis, SIX ou VR Pay |
| GICC_MAESTRO | Mastercard via Concardis, SIX ou VR Pay |
| GICC_MASTERCARD | Mastercard via Concardis, SIX ou VR Pay |
| GICC_VISA | Visa via Concardis, SIX ou VR Pay |
| GOOGLEPAY | |
| JCB | JCB France e Polinésia Francesa |
| PPRO | PPRO |
| PAYCONIQ | |
| PAYDIREKT_V2 | |
| PAYPAL | |
| PAYPAL_BNPL | PayPal Pay Later |
| PAYPAL_SB | PayPal- Modo sandbox |
| PAYPAL_BNPL_SB | PayPal Pay Later- Modo sandbox |
| PLANET_DCC | Planet Payment |
| POSTFINANCEV2 | |
| SEPA | SEPA DIRECT DEBIT |
| BHIM-UPI |
Formato
taxRefundAmount
Caminho: transactions.transactionDetails.taxRefundAmount
Usado no Uruguai, este campo corresponde ao valor do crédito de imposto dado ao EC para a transação. O valor deve ser apresentado na menor unidade monetária da moeda (o centavo para o Euro).
Exemplo: 30050 para 300,50 EUR.
Formato
occurrenceType
Caminho: transactions.transactionDetails.occurrenceType
Permite saber se a transação faz parte de uma série de pagamentos (assinatura ou pagamento em X vezes).
Útil para identificar de maneira precisa o primeiro pagamento de uma série.
Aplicando o Soft Declinem, a plataforma de pagamento realiza automaticamente uma nova tentativa de pagamento com autenticação 3D Secure, se for possível Isso modifica o número de sequência do pagamento. O campo sequenceNumber não permite mais identificar facilmente o primeiro pagamento de uma série.
Valores possíveis
| VALOR | Descrição |
|---|---|
| RECURRENT_INITIAL | Primeiro pagamento de uma série. |
| RECURRENT_INTERMEDIAIRE | Enésimo pagamento de uma série. |
| RECURRENT_FINAL | Último pagamento de uma série. |
| UNITAIRE | Pagamento unitário (pagamento à vista). |
Formato
archivalReferenceId
Caminho: transactions.transactionDetails.archivalReferenceId
Uma referência gerada pela plataforma de pagamento e transmitida ao adquirente para o processamento de remessas e conciliação de transações.
Válido somente para pagamentos CB, AMEX e PAYPAL.
Formato
serverDate
Data de geração da resposta. Permite medir a defasagem eventual entre os servidores do Estabelecimento Comercial e o serviço de pagamento.