Cria uma transação de cartão de crédito
Ambiente | Método | Endpoint |
|---|---|---|
Sandbox | post |
|
Produção | post |
|
Saiba mais sobre essa funcionalidade na documentação.
Atenção
-
Se as suas transações forem uma chamada conjunta com o Antifraude, os tamanhos de campos podem ser diferentes. Consulte o tópico Pagamento com Análise de Fraude;
-
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; -
As bandeiras JCB e Diners são estrangeiras e não permitem parcelamento no cartão de crédito;
-
Os parâmetros contidos dentro dos nós
AddresseDeliveryAddresssão de preenchimento obrigatório quando a transação é submetida ao Antifraude ou à análise do Velocity.
Identificação de transações oriundas de link de pagamento para cartões da bandeira EloA 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".
Autenticação 3DS nas transações de cartão de crédito
A autenticação 3DS é opcional para as transações de cartão crédito.
Se a sua loja tem integração com o protocolo 3DS para autenticação do portador do cartão, atente-se aos parâmetros que devem ser informados na requisição:
- Envie o parâmetro
Payment.Authenticate= "true"; - Informe os dados recebidos na saída do script do 3DS no nó
Payment.ExternalAuthentication; - Em transações com autenticação 3DS Data Only, informe o parâmetro
ExternalAuthentication.DataOnlycomo true.
Resposta da transação de cartão de crédito
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 crédito.
| Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
AcquirerTransactionId | Id da transação no provedor de meio de pagamento. | string | 40 |
ProofOfSale | Número do comprovante de venda, idêntico ao NSU (Número Sequencial Único). | string | 20 |
AuthorizationCode | Código de autorização. | string | 300 |
PaymentId | Campo identificador do pagamento. O PaymentId será usado em futuras operações como consulta, captura e cancelamento. | string | 36 |
ReceivedDate | Data em que a transação foi recebida pela Cielo. | datetime | 19 |
CapturedDate | Data em que a transação foi capturada. | string | 19 |
CapturedAmount | Valor capturado, sem pontuação. | integer | 15 |
ECI | Electronic Commerce Indicator. Representa o resultado da autenticação. | string | 2 |
ReasonCode | Código de retorno da API para indicar sucesso ou erro na operação. | string | 32 |
ReasonMessage | Mensagem correspondente ao ReasonCode. | string | 512 |
Status | Status da transação. Veja a lista completa de Status da Transação. | byte | 2 |
ProviderReturnCode | Código retornado pelo provedor do meio de pagamento (adquirente ou emissor). | string | 32 |
ProviderReturnMessage | Mensagem retornada pelo provedor do meio de pagamento (adquirente ou emissor). | string | 512 |
Payment.MerchantAdviceCode | Código de retorno da bandeira que define período para retentativa. Válido para bandeira Mastercard. Saiba mais em Programa de Retentativa das Bandeiras | string | 2 |
BrandTransactionId | Identificador de transações recorrentes junto às bandeiras na adquirente Rede. Exclusivo Rede. | string | 21 |