PCI/Charge/CreatePayment (PCI)

L'opération PCI/Charge/CreatePayment est un Web Service de l'API REST. Il permet de créer une nouvelle transaction authentifiée à partir d'un numéro de carte.

No modo PCI-DSS, você pode preencher as informações do cartão diretamente no Web Service.

Para uma utilização não PCI com o formulário incorporado, consulte: Charge/CreatePayment(non-PCI).

A noter que la précédente version dépréciée de ce web service peut-être trouvée ici : PCI/Charge/CreatePayment (depréciée)

Autenticação com nosso servidor de autenticação

Este serviço Web permite que você faça uma transação 3DS. É portanto necessário entender como funciona esta funcionalidade. Para ver como integrá-lo, a documentação de referência está disponível aqui: Web services PCI criação de de pagamento..

Ponto importante sobre os pagamentos CB

Aplicando a DSP2, os emissores podem recusar a transação se a autenticação 3D Secure não foi realizada Este comportamento é chamado “Soft Decline”.

No caso de 'um "Soft Decline" o campo transactionDetails.cardDetails.authorizationResponse.authorizationResult tem o valor de 81. É da responsabilidade do Estabelecimento Comercial iniciar um novo pagamento com uma autenticação 3D secure.

Autenticação com um outro servidor de autenticação

O serviço PCI/Charge/CreatePayment permite que os ECs PCI-DSS que realizaram a autenticação do titular do cartão através de seu próprio servidor de autenticação possam fazer pagamentos enviando nas próprias solicitações os dados do cartão e os dados de autenticação do portador.

Consulte o guia de integração para para maiores informações.

Configurações de entrada

O Web Service REST PCI/Charge/CreatePayment é compatível com as seguintes configurações:

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

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:

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

Formato

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

Formato

Valores possíveis

Os valores possíveis são os seguintes:

PAYMENT:

O webserviço retornará um formToken.

É o comportamento padrão. A chamada para Charge/CreatePayment vai criar uma transação sem realizar outras operações.

REGISTER_PAY:

O webserviço retornará um formToken.

Um Token do meio de pagamento será criado junto com a transação. Este Token lhe permitirá depois criar transações em um clique. O Token que foi criado será digitado na propriedade paymentMethodToken. Para maiores informações, ver Criação e uso de Token.

Tipo de meio de pagamento. Exemplo: PAYCONIQ

Formato

O PAN (Primary Account Number) é o número principal do cartão geralmente formado de 16 números).

Formato

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

Formato

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

Formato

Código de segurança (CVV).

O comprimento dele pode variar entre 3 ou 4 dígitos em função do tipo de cartão.

Formato

Rede do cartão.

Formato

Sobrenome e nome do portador do cartão

Formato

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

Formato

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

Tipo de documento de identidade.

Formato

Quantidade de parcelas.

Formato

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:

Formato

Token associado a um meio de pagamento.

Formato

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

Exemplo: 30050 para 300,50 EUR.

Formato

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

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

Formato

Endereço e-mail do comprador.

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

Formato

Endereço IP do comprador.

Formato

Endereço de faturamento.

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

Formato

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

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

Formato

Tipo de cliente.

Formato

Valores possíveis

Telefone mobile do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

Cidade de faturamento.

Formato

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

Formato

Valores possíveis

Exemplos de valores possíveis:

Bairro do endereço de faturamento.

Formato

Nome do comprador.

Formato

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

Formato

Tipo de documento de identidade.

Formato

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

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

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Valores possíveis

Exemplos de valores possíveis:

Sobrenome do comprador.

Formato

Razão social.

Formato

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

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

Formato

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

Carateres aceites:

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

Formato

Estado civil do comprador.

Exemplos:

• Sr.
• Sr.
• Sra.

Formato

CEP do endereço de faturamento.

Formato

Endereço de entrega.

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

Formato

Segunda linha do endereço de entrega.

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

Formato

Tipo de cliente.

Formato

Valores possíveis

Cidade de entrega.

Formato

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

Formato

Valores possíveis

Exemplos de valores possíveis:

Nome da empresa que entrega o produto.

Formato

Bairro do endereço de faturamento.

Formato

Nome do destinatário.

Formato

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

Formato

Sobrenome do comprador.

Formato

Razão social para uma entrega em uma empresa.

Formato

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

Modo de entrega.

Formato

Valores possíveis

Prazo de entrega.

Formato

Valores possíveis

Exemplos de valores possíveis:

Região do endereço de faturamento.

Formato

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

Carateres aceites:

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

Formato

CEP do endereço de faturamento.

Formato

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

Exemplo: 30050 para 300,50 EUR.

Formato

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

Exemplo: 30050 para 300,50 EUR.

Formato

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

Exemplo: 30050 para 300,50 EUR.

Formato

cardItemInfo é uma lista de objetos Customer/ShoppingCartItemInfo.

Permite descrever cada artigo do carrinho.

Formato

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

Exemplo: 30050 para 300,50 EUR.

Formato

Nome do produto.

Formato

Quantidade de produto.

Formato

Referência produto.

Formato

Tipo de produto.

Valores possíveis

Formato

Tipo de produto.

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

Valores possíveis

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

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

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

Formato

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

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

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

Permite definir a URL para qual sera redirecionado o navegador após uma autenticação 3D Secure que falhou.

Formato

Permite definir a URL para qual será redirecionado o navegador após uma autenticação 3D Secure realizada com sucesso.

Formato

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.

Tabela de isenções (valor DISABLED)

Formato

Permite especificar o caso de uso desejado.

Valor possível

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

Formato

Procedência do pagamento.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

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

Modo de validação da transação.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

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

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

Formato

Quantidade de parcelas.

Formato

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

Formato

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

Formato

Finalidade do uso do token do cartão.

Formato

Referência de encadeamento.

Formato

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

Valores possíveis

Formato

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

Valores possíveis

Formato

Nome da rede DS na qual a autenticação foi feita.

Valores possíveis

Formato

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

Valores possíveis

Formato

O tipo de autenticação que ocorreu.

Valores possíveis

Formato

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

Valores possíveis

Formato

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

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

Formato

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

Formato

Score de l'authentification spécifié par le DS, uniquement pour le réseau CB. Voir : Guide d'intégration.

Formato

Algorithme utilisé pour calculer le champ authenticationValue. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration.

Formato

RequestorName utilisé lors de l'authentification initiale. En général ce champ correspond au nom du marchand. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration.

Formato

Código de transação do DS (Obrigatório em 3D Secure V2).

Formato

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

Formato

Código único da transação.

Formato

Indica a razão que justifica a ausência de autenticação forte (Obrigatório em caso de status DISABLED, ou en caso de autenticação FRICTIONLESS).

Valores possíveis

Formato

Indicador de cancelamento de challenge recebido no RReq. (Valor retornado pelo DS no caso de cancelamento da autenticação).

Formato

Indica o motivo da falha de autenticação (Valor retornado pelo DS em caso de falha na autenticação).

Formato

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

CNPJ do revendedor de acordo com o campo companyType. Enviado pelo facilitador de pagamento.

Formato

Razão social do revendedor. Enviado pelo facilitador de pagamento.

Formato

URL do revendedor. Enviado pelo facilitador de pagamento.

Formato

Número de telefone do revendedor. Enviado pelo facilitador de pagamento.

Formato

Endereço do revendedor. Enviado pelo facilitador de pagamento.

Formato

Complemento do endereço do revendedor. Enviado pelo facilitador de pagamento.

Formato

CEP do revendedor. Enviado pelo facilitador de pagamento.

Formato

Cidade do revendedor. Enviado pelo facilitador de pagamento.

Formato

Código país do endereço do revendedor (norma ISO 3166 alfa-2). Enviado pelo facilitador de pagamento.

Formato

Código MCC do revendedor. Enviado pelo facilitador de pagamento.

Formato

Número de contrato (MID) do revendedor. Enviado pelo facilitador de pagamento.

Formato

Denominação (soft-descriptor) do revendedor que aparece no extrato bancário do comprador. Enviado pelo facilitador de pagamento.

Formato

Região do endereço do revendedor. Enviado pelo facilitador de pagamento.

Formato

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:

Ver a referência de cada resposta para maiores detalhes.