Create a credit card transaction
| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.braspag.com.br/v2/sales/ |
| Production | post | https://api.braspag.com.br/v2/sales/ |
Warning
- The
Payment.ServiceTaxAmountfield 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.ExternalAuthenticationnode;- The JCB and Diners brands are foreign and do not allow credit card installments.
Alphanumeric CNPJs will be implemented by the Brazilian Federal Revenue Service in July 2026This change applies only to new registrations. There will be no changes to existing CNPJs.
The alphanumeric CNPJ is already supported by Cielo, with no changes required to your integration.
We recommend checking whether adjustments are needed in your merchant’s own checkout systems.
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.ExternalAuthenticationnode; - For transactions with 3DS Data Only authentication, provide the parameter
ExternalAuthentication.DataOnlyas "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 thePayment.ExternalAuthenticationfield. However, the value actually used by the brand in the authorization is the one shown inPayment.Eci.
ImportantThe validation and return of the
Payment.Ecifield occur only in the production environment at this initial stage.
Visa Intelligent Data Exchange (IDX)
If you use Visa’s IDX authentication service, see Visa Intelligent Data Exchange (IDX).
Stored credential transaction identifiers
According to card brand rules, recurring transactions and those with stored credentials may require additional identification fields, such as IssuerTransactionId and TransactionLinkId. See more details below.
Card brand identifier: IssuerTransactionId
IssuerTransactionIdThe card brand identifier is an identification code for recurring or stored credential transactions, returned in the authorization response or in the card verification response (VerifyCard). See more details in IssuerTransactionId.
TLID Mastercard
The Transaction Link Identifier (TLID) is a unique identifier generated by the Mastercard card brand during a transaction. It is created in the initial transaction (CIT) and must be used to associate all subsequent transactions (MIT) within the same cycle.
| Phase | Description |
|---|---|
| Phase 1 | Availability of the TransactionLinkId in the responses of VerifyCard by card number, credit card payment creation, debit card payment creation, and in the query by PaymentId. |
| Phase 2 | Required inclusion of the TransactionLinkId in the request (MIT) starting Oct 23, 2026 |
See more details in Brand identifiers for Cielo.
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 |
|---|---|---|---|
| Transaction ID in the payment provider. | string | 40 |
| Sales receipt number, identical to the NSU (Unique Sequential Number). | string | 20 |
| Authorization code | string | 300 |
| Indicates which order number was sent to the acquirer.
| GUID | |
| Payment identifier field. | string | 36 |
| Date the transaction was received by Cielo. | datetime | 19 |
| Date the transaction was captured. | string | 19 |
| Captured amount, without punctuation. | integer | 15 |
| Electronic Commerce Indicator. Represents the authentication result. | string | 2 |
| API return code to indicate success or error in the operation. | string | 32 |
| Message corresponding to the | string | 512 |
| Transaction status. See the complete list of transaction status list. | byte | 2 |
| Code returned by the payment provider (acquirer or issuer). | string | 32 |
| Message returned by the payment provider (acquirer or issuer). | string | 512 |
| Brand return code that defines the retry period. Valid for Mastercard brand. Learn more at Merchant Advice Code (MAC) – Mastercard | string | 2 |
| Transaction identifier generated by the card brand; it must be sent to reference the original/previous transaction in related operations, such as recurring payments. See more details in Brand identifiers for Cielo acquirer. | string | 30 |
|
| string | 22 |
| Identifier for recurring transactions with card brands at acquirer Rede. Exclusive to Rede. | string | 21 |