Cria transação com o meio de pagamento cartão de débito.
Ambiente | Método | Endpoint |
|---|---|---|
Sandbox | post |
|
Produção | post |
|
Saiba mais sobre essa funcionalidade na documentação.
CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.
O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.
Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.
AtençãoOs retornos de autorização estão sujeitos a inserção de novos campos advindos das bandeiras/emissores.
Faça sua integração de forma a prever este tipo de comportamento utilizando adequadamente as técnicas de serialização e deserialização de objetos.
A API E-commerce aceita até 12 parcelas.
A captura da transação da crédito pode ser automática ou posterior.
- Para captura automática, envie o campo
Payment.Capturena requisição como “true”;- Para captura posterior, envie o campo como "false" e, posteriormente, faça a requisição de captura.
Atenção
- Não é possível realizar uma transação com valor (
Amount) 0. Para verificar a validade de um cartão, use o Zero Auth; - Transações de crédito Mastercard com credenciais armazenadas: a bandeira Mastercard exige o envio do Indicador de Início da Transação para compras de cartão de crédito e débito que usam os dados armazenados de um cartão. O objetivo é indicar se a transação foi iniciada pelo comprador (Cardholder-Initiated Transaction - CIT) ou pela loja (Merchant-Initiated Transaction - MIT). Nesse cenário é obrigatório o envio do nó
InitiatedTransactionIndicatorcom os parâmetrosCategoryeSubCategorypara transações Mastercard, dentro do nóPayment. Confira o exemplo do nó e a lista de categorias e subcategorias em Indicador de início da transação Mastercard; - O campo
Payment.ServiceTaxAmounté exclusivo para companhias aéreas e agências de turismo. Para as companhias aéreas, permite a cobrança da taxa de embarque separadamente do valor da passagem aérea. Já para as agências de turismo, é utilizado especialmente para a cobrança de taxas na primeira parcela; - O número de identificação do pedido (
MerchantOrderId) não sofre alteração ao longo do fluxo transacional. Contudo, um novo número (SentOrderId) pode ser gerado para o pedido e utilizado durante a transação. Esse número só será diferente se:- o
MerchantOrderIDenviado estiver fora das especificações descritas no campo; - o
MerchantOrderIDenviado já foi utilizado nas últimas 24 horas.
- o
- Para fins de conciliação, use o
TransactionId(TID).
Autenticação 3DS nas transações de cartão de débito
- Se a sua loja tem integração com o protocolo 3DS para autenticação do portador do cartão, informe os dados recebidos na saída do script no nó
Payment.ExternalAuthentication; - Em transações com autenticação 3DS Data Only, é necessário informar o parâmetro
ExternalAuthentication.DataOnlycomo true; - Para confirmar se a autenticação foi acatada na autorização, verifique o valor do ECI retornado em
Payment.Eci. A API replica o ECI informado pela loja no campoPayment.ExternalAuthentication. No entanto, o valor efetivamente utilizado pela bandeira na autorização é o que aparece emPayment.Eci.
ImportanteA validação e o retorno do campo
Payment.Eciocorrem apenas no ambiente de produção neste primeiro momento.
TLID Mastercard
O Transaction Link Identifier (TLID) é um identificador único gerado pela bandeira Mastercard durante uma transação, utilizado para estabelecer a continuidade entre transações relacionadas.
| Fase | Descrição |
|---|---|
| Fase 1 | Em breve disponibilizaremos o campo TransactionLinkId na resposta da validação de cartão por Zero Auth, criação de pagamento com cartão de crédito, criação de pagamento com cartão de débito e na consulta por PaymentId. |
| Fase 2 | Envio obrigatório do TransactionLinkId no request a partir de 23/10/2026 (MIT). |
Saiba mais em Identificadores de bandeira.
Resposta da transação de cartão de débito
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento com cartão de débito.
Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
| Número da autorização, idêntico ao NSU. | string | 6 |
| Identificador da transação na adquirente. | string | 20 |
| Código de autorização. | string | 6 |
| Número de identificação do pagamento. | GUID | 36 |
| Status da Transação. Veja a tabela completa de Status transacional | byte | |
| Código de retorno. | string | 32 |
| Mensagem de retorno. | string | 512 |
| Indica qual número de pedido foi enviado à adquirente.
| GUID | |
| Código de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais em Merchant Advice Code (MAC) e no Programa de retentativa das bandeiras para Mastercard | string | 2 |
| Retorna como "true" se a Garantia de Cancelamento estiver habilitada e ocorrer algum erro durante a autorização (status Não Finalizada - "0"). | boolean | |
| O PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação o campo não será retornado. | string | 29 |
| Identificador da transação gerado pela bandeira; deve ser enviado para referenciar a transação original/anterior em operações relacionadas, como em recorrências. Consulte mais informações em Identificadores da bandeira. | string | 30 |
| O Formato: 22 caracteres alfanuméricos (A-Z, a-z), com diferenciação entre maiúsculas e minúsculas e podem incluir hífens (-) e sublinhados (_). | string | 22 |