post https://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Cria transação com o meio de pagamento cartão de débito.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/sales |
| Produção | post | https://api.cieloecommerce.cielo.com.br/1/sales |
Saiba mais sobre essa funcionalidade na documentação.
A bandeira Hipercard foi descontinuada em 30/06/2025
Identificação de transações oriundas de link de pagamento para cartões da bandeira Elo
A partir de 17 de outubro de 2025 será obrigatório identificar transações oriundas de link de pagamento para cartões da bandeira Elo. Envie o parâmetro
Payment.SolutionType= "ExternalLinkPay".
Atenção
- Transações de débito 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 a lista de categorias na descrição do parâmetroCategorye a tabela completa desubcategorias emIndicador de início da transação Mastercard; - Não é possível realizar uma transação com valor (
Amount) = 0. Para verificar a validade de um cartão, use o Zero Auth.
Autenticação 3DS nas transações de cartão de débito
- A autenticação 3DS é obrigatória para as transações de débito. Na transação de débito padrão (com autenticação), envie
Authenticate= "true"; - 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 validar se a autenticação foi acatada na resposta da autorização, considere o ECI fora do nó
Payment.ExternalAuthentication.
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 |
|---|---|---|---|
Tid | Id da transação na adquirente. | Texto | 20 |
PaymentId | Número de identificação do pagamento. O PaymentId será usado em futuras operações como consulta e cancelamento. | Guid | 36 |
Status | Status da Transação. Veja a tabela completa de Status transacional | Byte | *** |
ReturnCode | Código de retorno da adquirência. | Texto | 32 |
SentOrderId | Informa qual número de pedido foi enviado à adquirente. Se o número do pedido enviado estiver em um formato inválido, a adquirente gerará um novo número, que será retornado no campo SentOrderId.Se o formato for válido e suportado pela adquirente, o campo SentOrderId trará o mesmo valor informado em MerchantOrderId. | Guid | - |
Payment.MerchantAdviceCode | Código de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais Programa de retentativa das bandeiras para Mastercard. | Texto | 2 |
Payment.DebitCard.PaymentAccountReference | 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. | Alfanumérico | 29 |