Create a debit card payment

Create a debit transaction

EnvironmentMethodEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/
Productionhttps://api.braspag.com.br/v2/sales/
⚠️

Warning

  • To validate if the authentication was accepted in the authorization response, consider the ECI outside the Payment.ExternalAuthentication node.

For the Sandbox environment, use the value "Simulado" in the Payment.Provider field.

⚠️

Identification of transactions originating from payment links for Elo cards

Starting October 17, 2025, it will be mandatory to identify transactions originating from payment links for Elo-branded cards. Send the parameter Payment.SolutionType = "ExternalLinkPay".


3DS Authentication in debit card payments

  • 3DS authentication is required for debit transactions. In a standard debit transaction (with authentication), send Authenticate = "true";
  • Provide the data received from the script output in the Payment.ExternalAuthentication node;
  • For transactions with 3DS Data Only authentication, the ExternalAuthentication.DataOnly parameter must be send as true.
  • To confirm if authentication was accepted in the authorization, check the ECI value returned in Payment.Eci. The API replicates the ECI informed by the merchant in the Payment.ExternalAuthentication field. However, the value actually used by the brand in the authorization is the one shown in Payment.Eci.

Debit card transaction response

Following table presents the main parameters that may be returned by the API when creating a debit card payment.Property

Description

Type

Type

Syze

AcquirerTransactionId

Transaction ID in the payment provider.

string

40

ProofOfSale

Sales receipt number, identical to the NSU (Unique Sequential Number).

string

20

SentOrderId

Indicates which order number was sent to the acquirer.

  • If the number provided is in an invalid format, the acquirer will generate a new identifier, returned in the SentOrderId field.
  • If the format is valid and accepted by the acquirer, the SentOrderId field will contain the same value provided in MerchantOrderId.

GUID


AuthorizationCode

Authorization code

string

300

PaymentId

Payment identifier field. PaymentId will be used in future operations such as query, capture, and void.

GUID

36

ReceivedDate

Date the transaction was received by Cielo.

string

19

ReasonCode

API return code to indicate success or error in the operation.

string

32

ReasonMessage

Message corresponding to the ReasonCode.

string

512

Status

Transaction status. See the complete list of transaction status list.

byte

2

ProviderReturnCode

Code returned by the payment provider (acquirer or issuer).

string

32

ProviderReturnMessage

Message returned by the payment provider (acquirer or issuer).

string

512

Payment.MerchantAdviceCode

Brand return code that defines the retry period. Valid for Mastercard brand. Learn more at card brands retry programs

string

2

Payment.ExternalAuthentication.Cavv

Cavv value submitted in the authorization request.

string

28

Payment.ExternalAuthentication.Xid

Xid value submitted in the authorization request.

string

28

Payment.ExternalAuthentication.Eci

Eci value submitted in the authorization request.

integer

1

Payment.ExternalAuthentication.Version

3DS version used in the authentication process.

string

1

Payment.ExternalAuthentication.ReferenceId

RequestID returned in the authentication process.

GUID

36


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