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.
Identification of transactions originating from payment links for Elo cardsStarting 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.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.
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 card brands retry programs | string | 2 |
| Identifier for recurring transactions with card brands at acquirer Rede. Exclusive to Rede. | string | 21 |