Criar pagamento de cartão de débito

Cria uma transação de débito

Ambiente

Método

Endpoint

Sandbox

https://apisandbox.braspag.com.br/v2/sales/

Produção

https://api.braspag.com.br/v2/sales/

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

Para o ambiente sandbox, use o valor "Simulado" no campo Payment.Provider.

ℹ️

CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026

Essa 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.

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.DataOnly como 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 campo Payment.ExternalAuthentication. No entanto, o valor efetivamente utilizado pela bandeira na autorização é o que aparece em Payment.Eci.
ℹ️

Importante

A validação e o retorno do campo Payment.Eci ocorrem 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.

FaseDescrição
Fase 1Em breve disponibilizaremos o campo TransactionLinkId na resposta da validação de cartão por VerifyCard, 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 2Envio obrigatório do TransactionLinkId no request a partir de 23/10/2026 (MIT).

Saiba mais em Indicadores 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

AcquirerTransactionId

Id da transação no provedor de meio de pagamento.

string

40

ProofOfSale

Número do comprovante de venda.

string

20

SentOrderId

Indica qual número de pedido foi enviado à adquirente.

  • Se o número informado estiver em formato inválido, a adquirente gerará um novo identificador, retornado no campo SentOrderId.
  • Se o formato for válido e aceito pela adquirente, o campo SentOrderId conterá o mesmo valor informado em MerchantOrderId.

GUID


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.

GUID

36

ReceivedDate

Data em que a transação foi recebida pela Cielo.

string

19

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 Merchant Advice Code (MAC) – Mastercard.

string

2

Payment.ExternalAuthentication.Cavv

Valor Cavv submetido na requisição de autorização.

string

28

Payment.ExternalAuthentication.Xid

Valor Xid submetido na requisição de autorização.

string

28

Payment.ExternalAuthentication.Eci

Valor Eci submetido na requisição de autorização.

integer

1

Payment.ExternalAuthentication.Version

Versão do 3DS utilizado no processo de autenticação.

string

1

Payment.ExternalAuthentication.ReferenceId

RequestID retornado no processo de autenticação.

GUID

36

Payment.IssuerTransactionId

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 para adquirente Cielo.

string

30

Payment.TransactionLinkId

O TransactionLinkId é um identificador único gerado pela Mastercard para cada transação. O TransactionLinkId deve ser usado para vincular a transação inicial com as demais subsequentes. Consulte mais informações em TLID Mastercard .

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


Body Params
string
required

Número de identificação do pedido. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco. Tamanho: 50.

Customer
object
Payment
object
Headers
string
required
Defaults to e3c24810-18bb-4bd7-88a0-a36d6b4a0731

Identificador da loja no Gateway de Pagamento. Tamanho: 36. Formato: GUID.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

string
required
Defaults to GQUAIWVDKUINZRHDQPLHUVHAIIFEIXFEXWPOYGHY

Chave pública para autenticação dupla no Gateway de Pagamento. Tamanho: 40. Formato: GUID.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

string

Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json