Create a credit card payment

Create a credit card transaction

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

Warning

  • The Payment.ServiceTaxAmount field is exclusive to airlines and travel agencies, allowing them to charge the boarding fee separately from the airfare;
  • To validate if the authentication was accepted in the authorization response, consider the ECI outside the Payment.ExternalAuthentication node;
  • The JCB and Diners brands are foreign and do not allow credit card installments.
⚠️

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 credit card payments

3DS authentication is optional for credit card transactions.

If your store integrates with the 3DS protocol for cardholder authentication, pay attention to the parameters that must be provided in the request:

  • Send the parameter Payment.Authenticate = "true";
  • Provide the data received from the 3DS script output in the Payment.ExternalAuthentication node;
  • For transactions with 3DS Data Only authentication, provide the parameter ExternalAuthentication.DataOnly 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.

Credit card transaction response

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

Property

Description

Type

Syze

AcquirerTransactionId

Transaction ID in the payment provider.

string

40

ProofOfSale

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

string

20

AuthorizationCode

Authorization code

string

300

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


PaymentId

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

string

36

ReceivedDate

Date the transaction was received by Cielo.

datetime

19

CapturedDate

Date the transaction was captured.

string

19

CapturedAmount

Captured amount, without punctuation.

integer

15

Payment.ECI

Electronic Commerce Indicator. Represents the authentication result.

string

2

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

BrandTransactionId

Identifier for recurring transactions with card brands at acquirer Rede. Exclusive to Rede.

string

21

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