Resposta PaymentOrder

Objeto contendo informações sobre uma ordem de pagamento.

Referência da resposta

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

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

channelType

Caminho: channelDetails.channelType

Tipo da ordem de pagamento para criar. O valor por default é "URL".

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
MAIL	A ordem de pagamento é enviada ao comprador por e-mail.
URL	Somente a criação da URL de pagamento retornada na resposta é realizada
SMS	A ordem de pagamento é enviada ao comprador por SMS
WHATSAPP	A ordem de pagamento é enviada na conta WhatsApp no comprador
INVOICE	A ordem de pagamento é enviada na forma de uma NF para pagar
IVR	A ordem de pagamento está criada e pode ser paga via o SVI

bcc

Caminho: channelDetails.mailDetails.bcc

BCC ("Blind Carbon Copy" ou "Copie Carbone Invisible"). Lista dos destinatários adicionais da ordem de pagamento. O destinatário principal (recipient) não pode ver estes destinatários. Use o ponto-e-vírgula “;” para separar cada endereço.

Formato

body

Caminho: channelDetails.mailDetails.body

Permite que você personalize o corpo do e-mail enviado. Se o parâmetro for vazio, a mensagem default se aplica.

Formato

Conteúdo

Para personalizar o corpo do e-mail, você pode usar as variáveis abaixo:

VALOR	Descrição
%url%	URL da ordem de pagamento. Se esta variável não estiver presente, o link de pagamento será adicionado automaticamente no final da mensagem.
%amount%	Valor e moeda do pagamento
%start_date%	Data de criação da ordem de pagamento.
%end_date%	Data de validade da ordem de pagamento
%shop_name%	Nome da sua loja como definido no Back Office
%reference%	Referência do pedido.
%shop_url%	URL da loja
%shop_contact%	Endereço e-mail do "gerente da loja" como definida no Back-Office

Exemplo: Este e-mail contém uma ordem de pagamento de um valor de %amount% válida até o dia %end_date%. Para confirmar o pagamento, clicar no link seguinte: %url%

recipient

Caminho: channelDetails.mailDetails.recipient

Destinatário do e-mail.

Formato

subject

Caminho: channelDetails.mailDetails.subject

Permite que você personalize o assunto do e-mail. Este parâmetro é obrigatório salvo se você especificar um nome de template válido no parâmetro channelOptions.mailOptions.template.

Formato

Conteúdo

Para personalizar o assunto do e-mail, usar as variáveis seguintes:

VALOR	Descrição
%url%	URL da ordem de pagamento, importante que ela conste no corpo do e-mail
%amount%	Valor e moeda do pagamento
%start_date%	Data de criação da ordem de pagamento.
%end_date%	Data de validade da ordem de pagamento
%shop_name%	Nome da sua loja como definido no Back Office
%reference%	Referência do pedido.
%shop_url%	URL da loja
%shop_contact%	Endereço e-mail do "gerente da loja" como definida no Back-Office

Exemplo: Oferta %referencia% válida de %start_date% ao %end_date% de um valor de %amount%

message

Caminho: channelDetails.smsDetails.message

Mensagem SMS para enviar.

Formato

phoneNumber

Caminho: channelDetails.smsDetails.phoneNumber

Número de telefone para envio de SMS.

Formato

phoneNumber

Caminho: channelDetails.whatsappDetails.phoneNumber

Número de telefone para o envio da mensagem WhatsApp.

Formato

ivrPaymentOrderId

Caminho: channelDetails.ivrDetails.ivrPaymentOrderId

Campo normalmente preenchido automaticamente pela plataforma Se o comprador tiver restrições funcionais específicas, este campo poderá excepcionalmente ser sobrescrito na entrada com sua própria referência numérica, a fim de garantir sua singularidade.

Formato

orderId

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

Formato

paymentOrderId

Referência única da ordem de pagamento gerada pela plataforma.

Formato

formAction

Permite definir o tipo de comportamento desejado para criar a transação.

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
PAYMENT	Criação de uma transação simples. Comportamento por padrão.
REGISTER	Criação de um Token sem pagamento O valor deve ser enviado a 0.
REGISTER_PAY	Criação de um Token durante um pagamento.
REGISTER_UPDATE	Modificação dos dados associados ao token.
REGISTER_UPDATE_PAY	Modificação das informações associadas ao token durante um pagamento.
ASK_REGISTER_PAY	Pagamento com criação de token proposta ao portador.
null	Se o valor for nulo ou não estiver definido, o valor PAYMENT será aplicado.

Formato

creationDate

Data e hora de criação da ordem de pagamento.

Formato

message

Mensagem da ordem de pagamento.

VALOR	Descrição da mensagem
URL	Mensagem destinada ao comprador, coma URL da ordem de pagamento
MAIL	Mensagem constituindo o conteúdo (body) do e-mail enviado

Formato

updateDate

Data e hora de atualização da ordem de pagamento.

Formato

paymentURL

URL a ser chamada para exibir a ordem de pagamento

Formato

paymentOrderStatus

Status da ordem de pagamento.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
RUNNING	Ordem de pagamento em curso. Pagamento pendente
PAID	Ordem de pagamento paga
REFUSED	Ordem de pagamento recusada
EXPIRED	Ordem de pagamento vencida
CANCELLED	Ordem de pagamento cancelada

dataCollectionForm

Uso do formulário de coleta de dados. Se definido com true , o formulário de coleta de dados será exibido antes do formulário de pagamento.

Formato

expirationDate

Data e hora de vencimento da ordem de pagamento, no formato ISO-8601.

Formato

locale

Parâmetro Regional (ou local) no formato cc_XX com:

cc representa o código idioma (dois caracteres em minúscula conforme à norma ISO-639 (exemplo "de" para alemão, "fr" para francês, "en" para inglês)
XX representa o código país (dois caracteres em maiúscula conforme à norma ISO-3166 (exemplo : "DE" para a Alemanha, "FR" para a França, "GB" para o Reino Unido).

Permite definir o idioma das páginas de pagamento e do e-mail de confirmação. Se esse parâmetro não for definido, será usado o idioma da loja.

Formato

merchantComment

Comentário associado à ordem de pagamento. Permite por exemplo indicar uma referência ao usuário criador da ordem de pagamento.

Formato

paymentReceiptEmail

Endereço e-mail do comprador para o qual será o recibo de pagamento é enviado. Esse recurso só funciona se a regra de notificação "E-mail de confirmação de pagamento à destinação do cliente" for ativada no Back Office EC.

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

allowDCFAmountUpdate

allowDCFAmountUpdate permite definir se modificar o valor for possível no formulário de coleta de dados Somente pode usar este campo se o campo dataCollectionForm tiver o valor true.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
NONE	O montante não pode ser alterado Comportamento por padrão.
LOWER	A quantia só pode ser alterada para baixo.
GREATER	A quantia só pode ser aumentada.
LOWER_AND_GREATER	A quantidade pode ser aumentada ou diminuída.
null	Se o valor for nulo ou não estiver definido, NONE será aplicado.

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

returnMode

returnMode permite especificar o método de envio dos dados usado quando voltar para o site de e-commerce.

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
NONE	Nenhum parâmetro será transmitido à URL de retorno para o site de e-commerce.
GET	Os campos de retorno serão enviados à URL de retorno sob a forma de um formulário HTTP GET (na "query string").
POST	Os campos de retorno serão enviados à URL de retorno sob a forma de um formulário HTTP POST. Se a volta para a loja ocorrer em um ambiente não https então o navegador exibirá um pop-up de segurança para o comprador.
null	Se o valor for nulo ou não estiver definido, NONE será aplicado.

Formato

returnUrl

returnUrl permite definir a URL para qual será redirecionado por default o comprador após teclar no botão Voltar para a loja, se as URLs errorUrl , refusedUrl , < successUrl ou cancelUrl não estiverem informadas.

Se este campo não foi enviado, a configuração do Back Office EC será levada em conta.

Se nenhuma URL for definida no Back Office EC ou no formulário, então o botão Voltar para a loja redirecionará o comprador para a URL do site de e-commerce (campo URL na configuração da loja).

Formato

cancelUrl

cancelUrl permite definie a URL para qual será redirecionado o comprador se ele teclar em Cancelar e voltar para a loja antes de realizar o pagamento.

Formato

successUrl

successUrl permite definir a URL para qual será redirecionado o comprador em caso de sucesso do pagamento, após teclar o botão Voltar para a loja.

Formato

refusedUrl

refusedUrl permite definir a URL para qual será redirecionado o comprador em caso de recusa, após teclar no botão Voltar para a loja.

Formato

errorUrl

errorUrl permite definir a URL para qual será redirecionado o comprador no caso de um erro de tratamento interno.

Formato

postWalletUrl

postWalletUrl permite definir a URL para qual será redirecionado o comprador durante um pagamento via um wallet em duas etapas.

Esta url é usada para transmitir informações relativas à escolha do comprador (e-mail, endereço de entrega, meio de pagamento, etc.).

A partir deste elementos, o Estabelecimento Comercial pode escolher qual ação realizar (ajustar custos de entrega, salvar o meio de pagamento, etc.) antes de deixar o comprador finalizar sua compra.

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

redirectSuccessTimeout

Permite definir um prazo em segundos antes do redirecionamento automático para o site de e-commerce no final de um pagamento aceito.

O valor oscila entre 0 e 300s.

Uma vez este prazo vencido, o comprador será redirecionado para a URL informada no campo successUrl. Se o campo não for informado, o comprador será redirecionado para a URL de retorno informada no campo returnUrl ou para a URL de retorno informada no bom. Se a URL de retorno não for definida, ele será redirecionado para a URL da loja.

Formato

redirectErrorTimeout

Permite definir um prazo em segundos antes do redirecionamento automático para o site de e-commerce no final de um pagamento recusado.

O valor oscila entre 0 e 300s.

Uma vez este prazo vencido, o comprador será redirecionado para a URL informada no campo errorUrl. Se o campo não for informado, o comprador será redirecionado para a URL de retorno informada no campo returnUrl ou para a URL de retorno informada no bom. Se a URL de retorno não for definida, ele será redirecionado para a URL da loja.

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

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

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). Você pode solicitar uma isenção de autenticação forte: Se o valor for inferior a € 100, a isenção é sistemática para comerciantes elegíveis. Se o valor estiver entre € 100 e € 250, um experimento está em andamento. O comerciante deve atender às seguintes condições: Tenha um contrato de CB. Seja elegível para o TRA do comprador. Transmita os valores necessários no fluxo 3D Secure, de acordo com as regras definidas pela plataforma. 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).

Você pode solicitar uma isenção de autenticação forte:

Se o valor for inferior a € 100, a isenção é sistemática para comerciantes elegíveis.
Se o valor estiver entre € 100 e € 250, um experimento está em andamento. O comerciante deve atender às seguintes condições:
- Tenha um contrato de CB.
- Seja elegível para o TRA do comprador.
- Transmita os valores necessários no fluxo 3D Secure, de acordo com as regras definidas pela plataforma.

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

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

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

manualValidation

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

captureDelay

Caminho: transactionDetails.cardDetails.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

firstAmount

Caminho: transactionDetails.installmentDetails.firstAmount

Primeiro valor do pagamento em N parcelas.

Formato

count

Caminho: transactionDetails.installmentDetails.count

Número de parcelas de pagamento em N vezes.

Formato

period

Caminho: transactionDetails.installmentDetails.period

Intervalo (dias) de pagamento em N parcelas.

Formato

amount

Caminho: transactionDetails.installmentDetails.schedules.amount

Valor da data de vencimento.

Formato

date

Caminho: transactionDetails.installmentDetails.schedules.date

Data de vencimento.

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.

Categoria

Tags

Resposta PaymentOrder

Referência da resposta

amount

Formato

currency

Formato

Valores possíveis

channelType

Caminho: channelDetails.channelType

Formato

Valores possíveis

bcc

Caminho: channelDetails.mailDetails.bcc

Formato

body

Caminho: channelDetails.mailDetails.body

Formato

Conteúdo

recipient

Caminho: channelDetails.mailDetails.recipient

Formato

subject

Caminho: channelDetails.mailDetails.subject

Formato

Conteúdo

message

Caminho: channelDetails.smsDetails.message

Formato

phoneNumber

Caminho: channelDetails.smsDetails.phoneNumber

Formato

phoneNumber

Caminho: channelDetails.whatsappDetails.phoneNumber

Formato

ivrPaymentOrderId

Caminho: channelDetails.ivrDetails.ivrPaymentOrderId

Formato

orderId

Formato

paymentOrderId

Formato

formAction

Valores possíveis

Formato

creationDate

Formato

message

Formato

updateDate

Formato

paymentURL

Formato

paymentOrderStatus

Formato

Valores possíveis

dataCollectionForm

Formato

expirationDate

Formato

locale

Formato

merchantComment

Formato

paymentReceiptEmail

Formato

taxAmount

Formato

taxRate

Formato

allowDCFAmountUpdate

Formato

Valores possíveis

Formato

metadata

Exemplo de chamada:

Formato

returnMode

Valores possíveis