Dúvidas de negócio

1. O que é a API Cielo E-commerce?

A API Cielo eCommerce é a evolução do webservice 1.5 como motor transacional online CIELO. Ele fornece uma API que permite ao lojista cielo realizar uma integração simplificada e modular A solução API Cielo eCommerce da plataforma Cielo eCommerce foi desenvolvida com a tecnologia REST, que é padrão de mercado e independe da tecnologia utilizada por nossos clientes, dessa forma, é possível integrar-se utilizando as mais variadas linguagens de programação, tais como: ASP, ASP. Net, Java, PHP, Ruby, Python, etc.

2. Qual a diferença entre o Webservice 1.5 e a API Cielo eCommerce?

A API Cielo eCommerce oferece novas funcionalidades além de um modelo de integração simplificado

3. Quais são os meios de pagamentos aceitos na API Cielo eCommerce?

A API Cielo eCommerce Cielo aceita os seguintes meios de pagamento:

4. Posso manter uma integração 1.5 e uma API Cielo eCommerce ao mesmo tempo?

Não é possível manter duas integrações simultâneas do webservice 1.5 e da API Cielo eCommerce Ao realizar o cadastro de uma das integrações junto ao Cielo Ecommerce será necessário escolher entre uma das plataformas Para maiores informações acesse: https://www.cielo.com.br/desenvolvedores A migração para a API Cielo Ecommerce é obrigatoria. O WebService 1.5 foi descontinuado e não possui suporte ou novos desenvolvimentos.

5. Não possuo a integração 1.5, posso utilizar a API Cielo eCommerce?

Sim, a integração da API Cielo eCommerce não depende uma integração previa ao webservice 1.5. Basta realizar um cadastro junto a Cielo, obtendo assim suas credenciais para transacionar Acesse https://www.cielo.com.br/desenvolvedores para maiores informações.

6. Como posso realizar a migração da 1.5 para a API Cielo eCommerce?

A Cielo disponibiliza um ambiente de Sandbox (https://bit.ly/2cHdrzr), onde desenvolvedor pode iniciar um processo de aprendizagem sobre a integração da API.

Após entender a integração, é necessário entrar em contato com o suporte e-commerce Cielo e solicitar a criação de novas credenciais de acesso ao ambiente de produção, assim será possível iniciar a integração em produção.

Para mais informações, acesse: https://developercielo.github.io/Guia-de-migracao-1.5x3.0

7. Possuo a 1.5, é necessário realizar uma nova homologação para utilizar a API Cielo eCommerce?

Sim, é necessário realizar uma nova homologação para validar a capacidade transacional de seu site. Para se integrar a API Cielo eCommerce em produção será necessário solicitar novas credenciais e iniciar uma nova homologação

8. Como posso liberar outros meios de pagamento além do cartão de crédito?

Para liberar novos meios de pagamento, você deve entrar em contato com o suporte do Cielo ecommerce e solicitar a ativação do meio de pagamento desejado Apenas os boletos necessitam de dados adicionais:

9. Como posso receber suporte Cielo?

O suporte ao lojista integrado a API Cielo eCommerce se dá pelos seguintes canais:

10. Onde posso acompanhar minhas vendas pela API Cielo eCommerce?

Via a área do lojista, no site https://minhaconta.cielo.com.br/wps/portal/est2/login

11. Qual o custo da API Cielo Ecommece?

Cada Feature da API Cielo ecommerce possui custos diferentes:

feature Tipo de custo Descrição
Transações de crédito Taxa Um valor % será cobrado sobre cada transação capturada. O Valor da taxa varia de acordo com o ramo de atividade descrito no CNPJ
Transações de Débito Taxa Um valor % será cobrado sobre cada transação capturada. O Valor da taxa varia de acordo com o ramo de atividade descrito no CNPJ
Transações de Boleto Emissão Um valor tabelado será cobrado por Boleto emitido. Verifique com o Comercial Cielo em qual categoria de custo sua loja está inserida
Analise de fraude Emissão Um valor tabelado será cobrado por transação analisada. Verifique com o Comercial Cielo em qual categoria de custo sua loja está inserida
Tokenização Não é cobrado Não há custo
Recorrência Não é cobrado Apenas a taxa sobre transações de crédito é cobrada
Consulta Bin Não é cobrado Não há custo
Wallets Não é cobrado Apenas a taxa sobre transações de crédito é cobrada

Dúvidas de Técnicas / Integração

1. Como funciona a solução API Cielo eCommerce da Cielo?

A solução API Cielo eCommerce da plataforma Cielo eCommerce foi desenvolvida com a tecnologia REST. O modelo empregado é bastante simples: Existem duas URLs (endpoint), uma específica operações que causam efeitos colaterais - como autorização, captura e cancelamento de transações, e uma URL específica para operações que não causam efeitos colaterais, como pesquisa de transações.

2. Há mudanças nas credenciais da 1.5 para a API Cielo eCommerce?

Sim, as credenciais utilizadas em cada plataforma são diferentes:

Exemplos

1.5

API Cielo eCommerce

Caso não saiba suas credenciais, entre em contato com o Suporte Cielo e informer o seu CNPJ/CPF. As credenciais serão enviadas ao e-mail cadastrado.

3. Como consigo as credenciais de cada ambiente?

Existem dois ambientes na API Cielo eCommerce, Sandbox e Produção.

4. É preciso algum software proprietário, como DLLs, para fazer a integração?

Não. A ausência de aplicativos proprietários é uma das características da solução: Não é necessário instalar aplicativos no ambiente da loja em nenhuma hipótese.

5. Preciso fazer uma afiliação antes de testar a integração?

Não é necessária uma afiliação para utilizar o Sanbox Cielo. Basta acessar o Cadastro do Sandbox e criar uma conta de testes. Ao fim do cadastro você receberá um MerchantId e um MerchantKey, que deverão ser utilizados para autenticar todas as requisições feitas para os endpoints da API.

6. Que tipo de conteúdo é enviado na integração?

Para simplificar ao máximo a solução API Cielo eCommerce, a integração é feita através do envio de JSONs numa arquitetura REST. Cada tipo de mensagem deve ser enviada para um recurso identificado através do path e enviada segundo o método HTTP adequado:

7. Como testar transações com meios de pagamento simulado?

Para realizar testes na API Cielo eCommerce, não é necessário utilizar cartões / meios de pagamentos reais. Cada meio de pagamento (Crédito, Débito, boleto e Transferência online) possui uma contra parte simulada.

8. Existe alguma regra para leitura de cartões?

A leitura dos dados do cartão no ambiente próprio é controlada por regras definidas pelo programa de segurança imposto pelas bandeiras de cartões.

Ademais, atendidos os requisitos, no momento do credenciamento E-commerce deve ser mencionada a escolha por leitura do cartão na própria loja.

9. É necessário usar algum certificado em para realizar a conexão com a API Cielo eCommerce

Sim, é necessário realizar a instalação do certificado SSL EV. Mais informações no Manual de integração

10. É necessário algum protocolo de segurança para a utilização da API Cielo eCommerce

É obrigatório o uso de TLS 1.2 na comunicação a API.

SSL,TLS 1.0 e 1.1 não são suportados. Integrações utilizando esses protocolos não poderão realizar transações.

11. Existe alguma restrição de Ips para consumir a API

Não há restrições de IP ou necessidade de uso de PROXYs para se integrar a API Cielo eCommerce

12. Como consultar transações de Sandbox??

O ambiente de Sandbox não possui uma área de relatórios, sendo necessario realizar uma consulta via API para visualizar transações nesse ambiente. Veja como realizar essa consulta em nosso manual de integração: https://developercielo.github.io/Webservice-3.0/#consultando-vendas

13. A API Cielo eCommerce possui SDKs em quais linguagens?

Sim, a API possui SDKs para:

Mais informações do repositório Cielo

14. A API Cielo eCommerce aceita pagamento com diferentes moedas e cartões internacionais?

OBS: Cartões internacionais não podem realizar parcelamento.

15. Poderei consultar informações sobre o meu contrato junto a Cielo (Taxa, prazo de deposito dos valores)?

Não, dados sobre tarifas e valores de cobrança não estão passiveis de consulta via API Cielo eCommerce Esses dados poderão ser consultados via a área do lojista no site Cielo ou via o suporte-cielo.

16. Poderei realizar antecipação de pagamentos pela API Cielo eCommerce?

Não, a API Cielo eCommerce se destina apenas ao processo de autorização de transações e atualização de dados de pedidos online. Dúvidas ou questões a respeito de agenda financeira e antecipação de recebíveis devem ser direcionadas ao Suporte-Cielo

17. Como minha integração será notificada a respeito das mudanças de status?

Mudanças de status serão notificadas via um POST HTTP direcionado a URL de notificação que deve ser cadastrada pelo suporte Cielo.

18. Como posso consultar dados a respeito das minhas vendas?

Será possível consultar via API ou via o portal Cielo:

19. O que é uma transação?

O elemento central do Cielo E-commerce é a transação, criada a partir de uma requisição HTTP ao Webservice da Cielo. A identificação única de uma transação na Cielo é feita através do campo TID, que está presente no retorno das mensagens de autorização. Esse campo é essencial para realizar consultas, capturas e cancelamentos.

20. Qual o prazo para uma autorização expirar?

O prazo para captura de uma transação é definido em seu cadastro Cielo e depende do ramo de atividade de sua empresa. Caso uma transação não seja capturada dentro desse limite, ela deixa de ser válida, não podendo mais ser capturada. O status da venda continuará como autorizado, mas não será possível altera-lo.

21. É possível fazer uma captura em um momento após a autorização?

Uma transação autorizada somente gera o crédito para o estabelecimento comercial caso ela seja capturada. Por isso, toda venda que o lojista queira efetivar será preciso realizar a captura (ou confirmação) da transação.

Para vendas na modalidade de Crédito, essa confirmação pode ocorrer em dois momentos:

  1. Imediatamente após a autorização (captura total) - não é necessário enviar uma requisição de captura, pois ela é feita automaticamente pela Cielo após a autorização da transação. Para tanto, é preciso configurar a requisição de transação definindo-se o valor “true” para a TAG conforme visto na seção “Criando uma transação”.
  2. Posterior à autorização (captura total ou parcial) - Já no segundo caso, é preciso fazer uma “captura posterior”, através de uma nova requisição ao Webservice da Cielo para confirmar a transação e receber o valor da venda.

Para mais informações sobre Captura de transações, acesso o Manual de integração

22. É possível cancelar uma transação?

O cancelamento é utilizado quando o lojista decide não efetivar um pedido de compra, seja por insuficiência de estoque, por desistência da compra pelo consumidor, ou qualquer outro motivo. Seu uso faz-se necessário principalmente se a transação estiver capturada, pois haverá débito na fatura do portador, caso ela não seja cancelada.

Se a transação estiver apenas autorizada e a loja queira cancelá-la, o pedido de cancelamento não é necessário, pois após o prazo de captura expirar, o valor não será cobrado do comprador e a transação será invalidada.

23. Qual diferença entra a notificação para cada tipo de pagamento?

Todas as alterações no status de seus pedidos serão notificadas via a URL de notificação, que deve ser cadastrada junto a Cielo. Os meios de pagamento possuem os mesmos Status, apenas sua ordem é alterada. Os status e diferenças dos meios de pagamento estão explicadas

Sobre Boletos: Apenas o boleto registrado Bradesco possui atualização de Status.

24. Onde posso validar os códigos de erro da API

Os códigos de erros da API e do POSTMAN são descritos dentro do Manual de integração

25. Onde encontro exemplos e coleções do Postman

Todos so exemplos e requisições da API estão disponiveis nos manuais abaixo:

26. Qual o limite de parcelamento Cielo

O limite de parcelamento da loja depende do cadastro realizado na Afiliação Cielo Entre em contato com o Suporte Cielo para maiores informações sobre o seu limite de parcelamento.

27. A Api possui atualização automatica de BINs?

Sim, a Cielo é integrada as principais bandeiras do mercado e é atualizada diariamente com os novos Bins emitidos ao redor do mundo.

Dúvidas sobre Recursos e Features

1. Quais features precisam ser habilitadas pela Cielo para utilização na API Cielo eCommerce em produção?

Por padrão, cada lojista utilizando a API Cielo eCommerce deve solicitar ao Suporte Cielo a habilitação das seguintes funcionalidades:

2. Quais Features estão disponíveis em sandbox?

Features Disponiveis em Sandbox:

Features Não Disponiveis em Sandbox:

Recorrência

1. O que é a Recorrência?

A Recorrência é um recurso para estabelecimentos que precisam cobrar regularmente por seus produtos/serviços. A recorrência é a execução de transações periódicas e pré-agendadas pelo lojista ou comprador. É um recurso muito utilizado para assinaturas de revistas, mensalidades, licenças de software, entre outros.

2. Quais são os tipos de recorrência da API Cielo eCommerce?

A API Cielo eCommerce disponibiliza duas estruturas de recorrência:

Recorrência Inteligente: O lojista envia uma transação de agendamento, com dados de pagamento e do comportamento da recorrência, A API replicará o conteúdo dessa transação e a executará automaticamente, sem a necessidade de interferência do lojista. Nesse método, serão disponibilizados recursos diferenciados para modelar a cobrança de acordo com o modelo de negócio adotado. Toda a parametrização é configurável, tais como: periodicidade, data de início e fim, quantidade de tentativas e intervalo.

Recorrência própria: Nesse método, o lojista deverá automatizar o envio das transações de acordo com a sua necessidade. A API apenas reconhece que se trata de uma transação de recorrência, não exigindo como o CVV como obrigatório. Todo o processo de execução periódica da recorrência fica a cargo do lojista

3. Quando uma recorrência é criada?

No caso da recorrência inteligente, a recorrência é criada no momento que a primeira transação (transação de agendamento) é “autorizada”, ou seja, mesmo que a venda não seja capturada, futuras transações ocorrerão com base nos dados de agendamento.

Para a recorrência própria, o início da recorrência e seu agendamento fica a cargo do lojista.

4. Posso personalizar o intervalo de recorrência?

Sim, é possível atualizar o intervalo da recorrência inteligente, mas somente para uma das opções de agendamento disponíveis

5. Como ocorre a notificação de novas recorrências?

A notificação de transações de recorrência inteligente são as mesmas enviadas para transações padrão. Para mais informações sobre as notificações de transações, acesse o Manual de integração

6. É possível atualizar dados de uma recorrência? Quais?

Sim, na recorrência inteligente, é possível atualizar dados de uma recorrência via um PUT dentro da API Cielo eCommerce. Os dados passiveis de modificação são:

7. Quais são as regras para atualizar o intervalo da recorrência.

A.Se o novo dia informado for depois do atual dia de agendamento, a atualização do dia da recorrência terá efeito na próxima recorrência.

B.Se o novo dia informado for antes do atual dia de agendamento, a atualização do dia da recorrência, só terá efeito depois que a próxima recorrência for executada com sucesso.

C.Se o novo dia informado for antes do atual dia de agendamento, mas a próxima recorrência for em outro mês, a atualização do dia da recorrência terá efeito na próxima recorrência.

8. Posso criar recorrência com todos os meios de pagamento?

Não, a recorrência Cielo está disponivel apenas para Cartão de crédito

Tokenização/Cartão protegido

1.O que é a tokenização/cartão protegido da API Cielo eCommerce

É uma plataforma que permite o armazenamento seguro de dados sensíveis de cartão de crédito. Estes dados são transformados em um código criptografado chamado de “token”, que poderá ser armazenado em banco de dados. Com a plataforma, a loja poderá oferecer recursos como “Compra com 1 clique” e “Retentativa de envio de transação”, sempre preservando a integridade e a confidencialidade das informações.

2.Quando é possível tokenizar um cartão?

É possível tokenizar o cartão em 2 momentos:

  1. No envio de uma transação: Ao se agendar uma recorrência ou em uma transação normal, mas indicar no contrato técnico que deseja salvar o cartão.
  2. Utilizando o contrato de salvamento de cartão disponível na documentação tecnica

3.É necessário ser PCI para armazenar os Tokens?

Não, para armazenar os tokens não é necessário ser certificado PCI

4.É necessário enviar o CVV para realizar uma transação somente com o token?

Não é obrigatório, mas a Afiliação Cielo (EC) deve ter permissão para transacionar sem CVV, caso contrario a transação será negada

5.É possivel tokenizar cartões de Débito?

Sim, é possivel tokenizar cartões de débito.

Autenticação

1.O que é autenticação?

A Autenticação é um fluxo de pagamento onde o comprador é direcionado ao banco emissor do cartão, para que o comprador seja identificado como o real portador no momento da compra

2.A Autenticação é obrigatória?

A autenticação é obrigatória apenas para cartão de débito, sendo uma opção para lojistas que desejem autenticar cartões de crédito

3.O redirecionamento é obrigatório?

Sim, o processo de autenticação exige que o comprador seja direcionado para o ambiente do banco.

4.É necessário habilitar a autenticação em meu cadastro Cielo?

Sim, é necessário que o lojista entre em contato com o suporte cielo e solicite que sua Afiliação possa estar apta a realizar autenticações online.

5.Quais bandeiras podem realizar a autenticação?

Visa e Mastercard

Analise de Fraude

1.O que é a análise de fraude Cielo?

É uma plataforma de prevenção à fraude que fornece uma análise de risco detalhada das compras on-line. Cada transação é submetida a mais de 260 regras, além das regras específicas de cada segmento, e geram uma recomendação de risco em aproximadamente dois segundos. Este processo é totalmente transparente para o portador do cartão. De acordo com os critérios preestabelecidos, o pedido pode ser automaticamente aceito, recusado ou encaminhado para análise manual.

2.A análise de fraude é obrigatória?

Não, a análise de fraude ocorre como um adendo ao processo de autorização de cartões de crédito. Basta que o Antifraude esteja habilitado em seu cadastro na Cielo. Para mais informações sobre como realizar uma análise de fraude

3.Caso ocorre um chargeback em uma venda analisada, serei reembolsado?

Não, a análise de fraude oferecida pela cielo apenas informa quais dados fogem do padrão de compra/atividades do comprador, indicando quais pontos apresentam maiores evidencias/risco de uma suposta fraude. A decisão de aceite da transação e sua captura são de inteira responsabilidade do lojista. Caso um chargeback seja realizado, a Cielo não se responsabiliza por reembolsar o lojista.

4.Posso utilizar um Antifraude próprio junto a API Cielo eCommerce?

Não, o lojista pode apenas utilizar o próprio AF Cielo como meio de analise dentro da API Cielo eCommerce

Zero Auth

1.O que é o Zero Auth

O Zero Auth é uma ferramenta de validação de cartões da API Cielo. A validação permite que o lojista saiba se o cartão é valido ou não antes de enviar a transação para autorização, antecipando o motivo de uma provável não autorização.

2.O que o Zero Auth faz?

O Zero Auth simula uma autorização Cielo, validando dados como:

3.O que o Zero Auth não pode fazer:

O Zero auth não informa:

4.Em quais cartões o Zero Auth funciona?

Apenas em cartões de crédito MasterCard e Visa.

5.Como integrar ao Zero Auth

O Zerto Auth é uma feature disponibilizada penas a alguns lojistas Cielo. Para saber mais sobre o modo de integração, entre em contato com o Suporte Ecommerce Cielo.

3DS 2.0

1.A autenticação é mandatória?

Atualmente sim, apenas para cartão de débito (3DS 1.0). As bandeiras Visa e Master já estão prontas com a solução 3DS 2.0 e os lojistas que quiserem, já poderão utilizar a nova solução. A princípio, a obrigatoriedade de adequação do lojista para a nova solução 3DS 2.0 passa a valer a partir de Abril de 2019 (cartões de débito, crédito e pré-pago).

2.A autenticação é suportada para quais bandeiras?

Por enquanto apenas Visa e Mastercard. A Elo disponibilizará em breve.

3.Quais emissores estão preparados para 3DS 2.0?

Nesse momento os emissores estão no modo piloto, ou seja, a ativação está acontecendo de forma controlada. A princípio Caixa e Banco do Brasil estão prontos.

4.O 3DS 2.0 está disponível para quais soluções Cielo?

API 3.0, 1.5 e checkout Cielo. Nas soluções 1.5 e 3.0 uma adequação técnica deve ser feita do lado do estabelecimento com base na documentação divulgada. Para o checkout, a adaptação técnica será feita no lado da Cielo.

5.Qual a diferença de linguagem/script em cada solução (API 3.0 e 1.5)?

A autenticação 3DS 2.0 é compatível tanto com a API 3.0, quanto com o Webservice 1.5. Porém, é necessário o envio dos dados de autenticação no momento da autorização, conforme descrito no manual técnico.

6.A Bandeira conseguirá incluir um score de cada cartão? Essa informação ficará armazenada?

A Bandeira efetua o cálculo de score, mas esse dado não é compartilhado com o estabelecimento. Ele será disponibilizado para o emissor para que essa seja uma informação adicional na decisão de autenticação (silenciosa ou desafio).

7.A partir de quando os clientes podem implantar a solução EMV 3DS 2.0?

Visa e Master já estão prontas. Caso o lojista esteja pronto, mas os bancos ainda não, as bandeiras farão análise das informações adicionais enviadas sobre o portador e incluirá um score da transação. Após isso, o banco emissor fará a autenticação. Esse processo continuará até os bancos emissores concluírem a adequação técnica do lado deles.

8.O cliente precisa continuar com antifraude se o liability shift passa para o banco emissor?

Com certeza. Caso não ocorra a autenticação, o antifraude auxiliará o lojista na tomada de decisão, pois terá a liberadade de continuar o fluxo e atingir a autorização da transação.

9.É possível diferenciar uma transação que está no 3DS 1.0 com a transação que está no 3DS 2.0? Como?

Sim. No retorno do script há um campo “version” que indicará qual a versão do 3DS. Se for 1, é 3DS 1.0, se for 2 é 3DS 2.0.

10.As bandeiras possuem uma data limite para os bancos estarem prontos?

A data limite da Visa (mandate Bandeira) é Agosto de 2019. A partir desse mês, mesmo que os bancos não estejam prontos, a responsabilidade pelo chargeback (liability shift) será do banco, desde que a transação seja submetida com solicitação de autenticação. A Master está com mandate em revisão e logo disponibilizará a data.

11.Sou cliente e estou fazendo o desenvolvimento da solução. A Cielo consegue verificar se o meu teste está correto? Como?

É possível o cliente rastrear possíveis erros no script no modo “DEBUG” na integração. Maiores detalhes na documentação.

Silent Order POST

1.A solução implica em algum custo adicional?

Não.

2.Quem tem Silent Order POST precisa ter a solução 3.0?

Sim. O Silent apenas substitui a necessidade de passar os dados do cartão abertamente. Desta forma, é necessário “chamar” o e-Commerce 3.0 para autorizar a transação.

3.A solução é compatível com Webservice 1.5?

Não.

4.Registrar o IP é obrigatório?

Sim, por questão de segurança, este procedimento é obrigatório

5.Há um ambiente de testes para homologarmos o Silent Order Post?

Sim, o Sandbox é compatível com Silent Order POST como mostrado na documentação.

6.Estou recebendo erro 500 na hora de pedir o accesstoken, o que pode ser?

Verificar se o endpoint está correto e tamém verifique se o IP de origem está liberado na plataforma.

Integração de Gateways

1.Utilizo um Gateway de pagamentos. Posso usar a API Cielo Ecommerce?

Sim, mas é necessarios que o seu Gateway esteja integrado a API Cielo Ecommerce e possua suas credenciais de acesso (MerchantKey e MerchantID)

2.Como um gateway de pagamentos pode se integrar?

Utilizando a mesma integração padrão de um lojista Cielo, entretando o Gateway precisará possuir as credenciais do lojista para poder realizar autorizações de pagamentos.

Pagamento com Credenciais (Cartão) Armazenadas

Para armazenar dados de cartão (seja através de terceiros ou não) e utilizá-lo em vendas futuras, você precisa obter o consentimento prévio do portador e enviar algumas informações que identifiquem que se trata de uma transação com credenciais armazenadas.

Essas informações deverão ser enviadas nó CardOnFile e variam de acordo com o tipo de transação. Caso não se trate de uma transação com credenciais armazenadas, não é necessário enviar este nó.

No campo “Usage” você deverá indicar se é a primeira transação utilizando um cartão que ficará armazenado para ser usado futuramente (seja em compras pontuais ou recorrências) ou se é uma transação usando credenciais armazenadas anteriormente. Caso seja a primeira transação o valor deve ser “First”. Caso seja uma transação usando credenciais armazenadas que já foram utilizadas em uma transação anterior, o valor deverá ser “Used”.

No campo “Reason”, você deverá indicar o motivo pelo qual o merchant está autorizando uma transação com credencias já armazenadas anteriormente (modelo MIT - Merchant Initiated Transaction). Trata-se de um dado obrigatório nesse modelo. São eles:

a) Transação recorrente: transações geradas seguindo uma recorrência pré-definida no momento da primeira transação. Neste caso a transação é gerada sem a necessidade de nenhuma intervenção por parte do cliente, por exemplo assinatura de serviços online e plano de celular. Neste caso o campo reason deve ser preenchido como “Recurring”.

b) Transação recorrente sem periodicidade: este tipo de transação similarmente a transação recorrente, é gerado sem a intervenção do cliente, porém não há uma periodicidade pré-definida. Ela é gerada sempre que o cliente consome o produto ou serviço, por exemplo aplicativos de transporte e de aluguel de bicicletas. Neste caso o campo reason deve ser preenchido como “Unscheduled”.

c) Compra parcelada em transações: neste tipo de transação, diferente do parcelamento tradicional, não há a pré-autorização do valor total da compra no cartão do cliente. Ao invés de inibir o valor total no cartão do cliente e efetuar a captura parcelada, neste caso cada parcela gera uma nova transação na periodicidade acordada até se chegar ao valor total. Por exemplo, uma academia que vende uma afiliação anual e parcela o pagamento mensalmente. Neste caso o campo reason deve ser preenchido como “Installments”.

Exemplos de integração:

** Modelo CIT (card holder intiated): **

  1. Primeira compra com consentimento do cliente para armazenar credenciais para uso futuro:
{
  "MerchantOrderId": "24440380271234",
  "Customer": {
    "Name": "Comprador de Teste"
  },
  "Payment": {
    "Type": "creditcard",
    "Amount": 100,
    "Installments": 1,
    "Creditcard": {
      "CardNumber": "516220******6991",
      "Holder": "Portador de Teste",
      "ExpirationDate": "09/2019",
      "SecurityCode": "***",
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "First"
      }
    }
  }
}
  1. Compra eventual e/ou pontual usando credenciais armazenadas previamente:
{
  "MerchantOrderId": "24440380271234",
  "Customer": {
    "Name": "Comprador de Teste"
  },
  "Payment": {
    "Type": "creditcard",
    "Amount": 100,
    "Installments": 1,
    "Creditcard": {
      "CardNumber": "516220******6991",
      "Holder": "Portador de Teste",
      "ExpirationDate": "09/2019",
      "SecurityCode": "***",
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Unscheduled"
      }
    }
  }
}

** Modelo MIT (merchant initiated): **

OBS.: o campo “Reason” será obrigatório nesses casos!

  1. Compra recorrente com periodicidade pré-definida usando credenciais armazenadas previamente:
{
  "MerchantOrderId": "24440380271234",
  "Customer": {
    "Name": "Comprador de Teste"
  },
  "Payment": {
    "Type": "creditcard",
    "Amount": 100,
    "Installments": 1,
    "Creditcard": {
      "CardNumber": "516220******6991",
      "Holder": "Portador de Teste",
      "ExpirationDate": "09/2019",
      "SecurityCode": "***",
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Recurring"
      }
    }
  }
}
  1. Compra recorrente sem periodicidade definida usando credenciais armazenadas previamente:
{
  "MerchantOrderId": "24440380271234",
  "Customer": {
    "Name": "Comprador de Teste"
  },
  "Payment": {
    "Type": "creditcard",
    "Amount": 100,
    "Installments": 1,
    "Creditcard": {
      "CardNumber": "516220******6991",
      "Holder": "Portador de Teste",
      "ExpirationDate": "09/2019",
      "SecurityCode": "***",
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Unscheduled"
      }
    }
  }
}
  1. Compra parcelada em transações:
{
  "MerchantOrderId": "24440380271234",
  "Customer": {
    "Name": "Comprador de Teste"
  },
  "Payment": {
    "Type": "creditcard",
    "Amount": 10,
    "Installments": 1,
    "Creditcard": {
      "CardNumber": "516220******6991",
      "Holder": "Portador de Teste",
      "ExpirationDate": "09/2019",
      "SecurityCode": "***",
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Installments"
      }
    }
  }
}
Documentações e tutoriais

Materiais complementares

Contato
GitHub