Web service Token/Update
O serviço Web REST Token/Update permite que você atualize o cartão anexado a um alias (paymentMethodToken).
Atualize um alias exibindo um formulário de pagamento usando o formToken ( Etapa 3: Criar um formToken ).
Veja os parâmetros de resposta do Token .
Configurações de entrada
paymentMethodToken
Token associado a um meio de pagamento.
Formato
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 |
orderId
Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.
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
customer.ipAddress
Endereço IP do comprador.
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
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
contrib
Nome da solução e-commerce usada no site de e-commerce bem como o número da versão.
Formato
ipnTargetUrl
Você pode sobrescrever a URL de notificação instantânea (também chamada IPN) no formulário se você usar uma só loja para diferentes canais de venda, diferentes tipologias de pagamento, diferentes idiomas etc...
Formato
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
mid
Caminho: transactionOptions.cardOptions.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
paymentSource
Caminho: transactionOptions.cardOptions.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". |
retry
Caminho: transactionOptions.cardOptions.retry
Quantidade de novas tentativas disponíveis no caso de uma recusa de pagamento (1 por padrão).
Formato
formTokenVersion
formTokenVersion define a versão do formToken retornado pelo web service.
Este parâmetro é usado no âmbito do SDK mobile. Permite garantir que a versão do formToken retornado continua sendo adequada ao aplicativo mobile instalado no telefone do comprador.
O valor por padrão é 4.
Formato
Referência da resposta
| Resposta | Contexto |
|---|---|
| Objeto contendo um hash a ser usado com o formulário embutido para criar uma nova transação. |
Ver a referência de cada resposta para maiores detalhes.