Web Service Charge/CreatePayment

POSThttps://api.lyra.com/api-payment/V4/Charge/CreatePayment

Caso de uso

Caso de uso	VALOR	LINK
Criando uma transação simples	Valorizar o campo`formAction`a`PAYMENT`.	Iniciar rapidamente
Criando um alias com um pagamento	Valorizar o campo`formAction`a`REGISTER_PAY`.	Criação de um token com pagamento
Pagamento com criação de token proposta ao portador.	Valorizar o campo`formAction`a`ASK_REGISTER_PAY`.	Criação de um token com pagamento
Pagamento 0 clique	Valorizar o campo`formAction`a`SILENT`e o campo`paymentMethodToken`com o apelido.	Pagamento 0 clique
Pagamento com 1 clique	Valorizar o campo`formAction`a`PAYMENT`e o campo`paymentMethodToken`com o apelido.	Pagamento 1 clique
Pagamento com Wallet (carteira eletrônica)	Valorizar o campo`formAction`a`CUSTOMER_WALLET`e o campo`customer.reference`.	Gestão dos wallets comprador
Criando uma transação inicial para dinheiro na remessa	Valorizar o campo`useCase`a`SHIPMENT_MULTIPLE_AUTHORISATION`.	Realizar um pagamento no envio

Configurações de entrada

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

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

contrib

Nome da solução e-commerce usada no site de e-commerce bem como o número da versão.

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

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

orderId

Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.

Formato

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 Back Office EC.

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

formAction

formAction permite definir o comportamento desejado quando criar a transação.

Formato

Valores possíveis

. Os valores possíveis são:

VALOR	Descrição
PAYMENT	Criação de uma transação simples. Comportamento por padrão.
REGISTER_PAY	Criação de um Token do meio de pagamento junto com a transação. Não permite criar um Token associado a um IBAN.
ASK_REGISTER_PAY	Adiciona uma flag no formulário para a criação de um token. Não permite criar um Token associado a um IBAN.
SILENT	Transação iniciada pelo EC na ausência do comprador Realiza um pagamento por Token sem passar pelo formulário incorporado.
CUSTOMER_WALLET	Adiciona uma caixa a assinalar no formulário para associar o cartão ao wallet O campo customer.reference é obrigatório para este caso de uso. Consulte o guia de integração para para maiores informações.
null	Se o valor for nulo ou não definido, PAYMENT se aplica.

PAYMENT

Le Web Service retourne un formToken.

C'est le comportement par défaut. L'appel à Charge/CreatePayment crée une transaction sans effectuer d'opération supplémentaire.

REGISTER_PAY

Le Web Service retourne un formToken.

Un alias (ou token) du moyen de paiement est créé en même temps que la transaction. Cet alias vous permet ensuite de créer des transactions en un clic. L'alias nouvellement créé est renseigné dans la propriété paymentMethodToken. Plus d'informations, voir : Création et utilisation d'alias.

ASK_REGISTER_PAY

Le Web Service retourne un formToken.

Ce paramètre permet d'ajouter dans le formulaire de paiement une case à cocher demandant à l'acheteur s'il veut enregistrer sa carte.

Ação do comprador	Descrição
A caixa está assinalada	Registra um alias de cartão (formAction=REGISTER_PAY).
A caixa não está assinalada	O alias não foi criado (formAction=PAYMENT). Comportamento padrão.

Para obter mais informações, consulte: Criando e usando aliases.

CUSTOMER_WALLET

Le Web Service retourne un formToken.

Ce paramètre permet d'ajouter dans le formulaire de paiement une case à cocher demandant à l'acheteur s'il veut enregistrer sa carte dans son wallet. Nécessite la référence acheteur customer.reference.

Ação do comprador	Descrição
A caixa está assinalada	Adiciona um cartão no wallet.
A caixa não está assinalada	Comportamento padrão. O cartão não é adicionado à carteira.

SILENT Réservé pour les transactions initiées par le marchand sans la présence de l'acheteur et notamment pour les paiements récurrents lorsque la récurrence est gérée par le marchand.

No domínio de aplicação da DSP2, a autenticação do portador é obrigatória quando ele está presente O modo SILENT é portanto reservado quando o portador estiver ausente ou para os EC fora da zona DSP2.

Na zona de aplicação da DSP2, o campo strongAuthentication é ignorado e nenhuma autenticação do portador é realizada.

Le Web Service retourne directement une transaction plutôt qu'un formToken lors d'un paiement par alias (token). La transaction se fait donc de serveur à serveur.

paymentMethodToken

Token associado a um meio de pagamento.

Formato

strongAuthentication

strongAuthentication permite indicar a preferência do EC para autenticação do comprador.

Sem interação do portado ( frictionless ).
Com interação do portador (autenticação forte ou challenge ).
Nenhuma preferência do EC.

Uma autenticação forte é requerida ao salvar um cartão. Use o campo formAction com os valores seguintes:

REGISTER_PAY : para realizar um pagamento ao salvar um meio de pagamento.
ASK_REGISTER_PAY : para realizar um pagamento com uma solicitação para salvar o meio de pagamento.
CUSTOMER_WALLET : para salvar o meio de pagamento.

Neste caso, o valor do campo strongAuthentication torna-se automaticamente CHALLENGE_MANDATE.

Caso de uso	Valores possíveis
CHALLENGE : Com interação do portado	ENABLED : Valor depreciado
	CHALLENGE_REQUESTED : Permite solicitar uma autenticação forte para a transação.
	CHALLENGE_MANDATE : Permite solicitar uma autenticação forte para a transação por razões legais.
FRICTIONLESSSem interação do portado Opção "Frictionless 3DS2" obrigatório.	DISABLED: Permite solicitaruma isençãode autenticação forte. Transações de baixo valor LRM (Low Risk Merchant) Se você não possui a opção “Frictionless 3DS2”, a escolha da preferência é delegada ao emissor do cartão (No Preference). Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.
Nenhuma preferência do EC	NO_PREFERENCE : Permite indicar ao DS que o EC não tem preferência. Se o emissor decidir realizar uma autenticação sem interação (frictionless), o pagamento será garantido.
Nenhuma preferência do EC	AUTO : Cabe ao emissor do cartão escolher a preferência (No Preference).

Tabela de isenções (valor DISABLED)

isenção	Descrição
Transações de baixo valor	Para os pagamentos em euro, pode solicitaruma isençãoa autenticação forte: Se o valor for inferior a 30 €, e no limite de 5 operações sucessivas ou de um valor cumulado inferior a 100 €. Se o valor for superior a 30€, o valor enviado pelo EC será ignorado e a escolha da preferência caberá ao emissor do cartão ( No Preference ). Para os pagamentos realizados em uma outra moeda que o euro, uma solicitação de frictionless será enviada ao emissor.Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.
LRM (Low Risk Merchant)	O programa LRM (Low Risk Merchant) de CB procura atender às necessidades de comerciantes de alto volume e risco muito baixo (120.000 transações CB / ano). Vous pouvez demander une exemption à l'authentification forte : Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles. Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions : Avoir un contrat CB. Etre éligible à la TRA acquéreur. Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme. Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador. Para se beneficiar do programa LRM da CB, você deve entrar em contato com o suporte técnico para obter um contrato explícito.

isenção

Descrição

Transações de baixo valor

Para os pagamentos em euro, pode solicitaruma isençãoa autenticação forte:

Se o valor for inferior a 30 €, e no limite de 5 operações sucessivas ou de um valor cumulado inferior a 100 €.
Se o valor for superior a 30€, o valor enviado pelo EC será ignorado e a escolha da preferência caberá ao emissor do cartão ( No Preference ).

Para os pagamentos realizados em uma outra moeda que o euro, uma solicitação de frictionless será enviada ao emissor.Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.

LRM (Low Risk Merchant)

O programa LRM (Low Risk Merchant) de CB procura atender às necessidades de comerciantes de alto volume e risco muito baixo (120.000 transações CB / ano).

Vous pouvez demander une exemption à l'authentification forte :

Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles.
Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions :
- Avoir un contrat CB.
- Etre éligible à la TRA acquéreur.
- Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme.

Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.

Formato

acquirerTransientData

Permite enviar informações específicas a certos adquirentes / redes.

Uso com Conecs

Campo facultativo que permite enviar o valor dos produtos elegíveis que podem ser pagos com Título Restaurante CONECS.

Se o campo não for enviado, é a totalidade do valor que será considerada como elegível para o pagamento Título-Restaurante, inclusive as despesas eventuais de entrega inclusas no valor do pedido.

Exemplo para um valor elegível de 17.25€:

Exemplo: .

{"CONECS":{"eligibleAmount":"1725"}}

Restringir os códigos BIN aceitos

Para limitar os cartões aceitos para o pagamento em função do código BIN, o formato esperado é o seguinte:

{"MULTI":{"bins": ["bin1","bin2","bin3"]}}

NB : Suporta códigos BIN de 6 dígitos ou de 8 dígitos.

Exemplo: .
Código BIN para6 números: 4012 34XX XXXX XXXX;
Código BIN para8 números: 4000 1234 XXXX XXXX.

Formato

paymentMethods

Lista dos meios de pagamento para propor ao comprador.

Exemplo: ["VISA", "MASTERCARD"]

Se a lista tiver somente um meio de pagamento, a página para preencher os dados deste meio de pagamento será diretamente exibida. Se não, a página de seleção dos meios de pagamentos será exibida.

Se este campo estiver vazio (aconselhado) então os meios de pagamento elegíveis (moedas, obrigações técnicas, etc.) associadas à loja serão propostas.

Formato

customer.reference

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

Obrigatório se formAction tiver o valor CUSTOMER_WALLET.

Neste caso, a referência do comprador é usada como login do wallet.

Formato

customer.email

Endereço e-mail do comprador.

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

Este parâmetro é obrigatório ao criar um alias (definindoformActionaREGISTER_PAY,ASK_REGISTER_PAYouCUSTOMER_WALLET).
Se este parâmetro estiver ausente ao criar oformToken(Criar um formToken), a plataforma exibe automaticamente um campo para inserir o e-mail 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

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

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

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 Back Office EC, pagamentos por arquivo, pagamentos recorrentes, pagamentos por proximidade, reembolsos do CMS Shopify.
Absent ou null	O valor por default é "EC".

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

manualValidation

Caminho: transactionOptions.cardOptions.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 Back Office EC).

captureDelay

Caminho: transactionOptions.cardOptions.captureDelay

Prazo para aplicar na data de captura.

Descrição

Indica o prazo em número de dias antes da captura no banco.

Se este parâmetro não é enviado, então o valor padrão definido no Back Office EC será usado.

Este último pode ser configurado no Back Office EC por todas as pessoas devidamente autorizadas.

Se o prazo anterior à captura for superior a 365 dias na solicitação de pagamento, ele será automaticamente redefinido a 365 dias.

Formato

firstInstallmentDelay

Caminho: transactionOptions.cardOptions.firstInstallmentDelay

Quantidade de meses adiados para aplicar na primeira parcela para um pagamento parcelado. Campo específico aos adquirentes da América Latina.

Formato

installmentNumber

Caminho: transactionOptions.cardOptions.installmentNumber

Quantidade de parcelas.

Formato

retry

Caminho: transactionOptions.cardOptions.retry

Quantidade de novas tentativas disponíveis no caso de uma recusa de pagamento (1 por padrão).

Formato

debitCreditSelector

Caminho: transactionOptions.cardOptions.debitCreditSelector

Campo específico ao Brasil para a gestão dos cartões "múltiplo".

Os cartões “múltiplo” são cartões de pagamento (Elo, Visa ou Mastercard), que permitem pagar:

ou em débito imediato: o valor é debitado imediatamente, e o EC será creditado o dia seguinte.
ou em crédito: o débito é diferido e o valor pode ser debitado em uma ou mais vezes. Mais tarde, o EC é creditado da totalidade ou de apenas uma parte do valor total.

Este campo permite forçar o uso do cartão em débito ou em crédito.

Valores possíveis

valores	Descrição
DEBIT	Uso da função "débito" do cartão
CREDIT	Uso da função "crédito" do cartão

Formato

initiatedTransactionIndicator

Caminho: transactionOptions.cardOptions.initiatedTransactionIndicator

Finalidade do uso do token do cartão.

Formato

initialIssuerTransactionIdentifier

Caminho: transactionOptions.cardOptions.initialIssuerTransactionIdentifier

Referência de encadeamento.

Formato

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

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

useCase

Permite especificar o caso de uso desejado.

Valor possível

Valor a ser inserido para pagamento múltiplo na expedição:

VALOR	Descrição
SHIPMENT_MULTIPLE_AUTHORISATION	Caso de uso “Pagamento na expedição com autorizações múltiplas”

Formato

overridePaymentCinematic

Permite modificar o modo de entrega. Específico aos adquirentes da América Latina. Esta funcionalidade não pode ser usada na Colômbia.

Valores possíveis:

VALOR	Descrição
IMMEDIATE_CAPTURE	Cinemática de captura imediata: a captura é iniciada pelo adquirente, o dia do pagamento.
DELAYED_CAPTURE	Cinemática de captura adiada: a captura será iniciada pela plataforma de pagamento, sempre antes do vencimento da solicitação de autorizaçã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

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

Referência da resposta

Mais de uma resposta são possíveis em função do contexto:

Resposta	Contexto
Payment	Objeto contendo a transação gerada. Este objeto é diretamente retornado no caso de um pagamento por código simples.
Charge/PaymentForm	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.

Categoria

Tags

Web Service Charge/CreatePayment

Caso de uso

Configurações de entrada

amount

Formato

amount

Formato

contrib

Formato

currency

Formato

Valores possíveis

ipnTargetUrl

Formato

orderId

Formato

metadata

Exemplo de chamada:

Formato

fingerPrintId

Formato

formAction

Formato

Valores possíveis

paymentMethodToken

Formato

strongAuthentication

Tabela de isenções (valor DISABLED)

Formato

acquirerTransientData

Uso com Conecs

Restringir os códigos BIN aceitos

Formato

paymentMethods

Formato

customer.reference

Formato

customer.email

Formato

address

Caminho: customer.billingDetails.address

Formato

address2

Caminho: customer.billingDetails.address2

Formato

category

Caminho: customer.billingDetails.category

Formato

Valores possíveis

cellPhoneNumber

Caminho: customer.billingDetails.cellPhoneNumber

Formato

city

Caminho: customer.billingDetails.city

Formato

country

Caminho: customer.billingDetails.country

Formato

Valores possíveis

district

Caminho: customer.billingDetails.district

Formato

firstName

Caminho: customer.billingDetails.firstName

Formato

identityCode

Caminho: customer.billingDetails.identityCode

Formato

identityType

Caminho: customer.billingDetails.identityType

Formato

language

Caminho: customer.billingDetails.language

Formato

Valores possíveis

lastName

Caminho: customer.billingDetails.lastName

Formato