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.

⚠️

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


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.

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.

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

Language
Click Try It! to start a request and see the response here!