Create a transaction with the payment method credit card
Environment | Method | Endpoint |
|---|---|---|
Sandbox | post |
|
Production | post |
|
WarningAuthorization responses are subject to the addition of new fields from card brands/issuers.
Integrate in a way that anticipates this behavior by properly using serialization and deserialization techniques.
The capture of the credit transaction can be automatic or later.
- For automatic capture, send the
Payment.Capture`parameter in the request as “true”;- For later capture, send the parameter as "false" and subsequently make the capture after authorization.
API E-commerce accepts up to 12 installments.
Warning
- It is not possible to perform a transaction with an
Amountof 0. To verify the validity of a card, use Zero Auth; - Mastercard credit transactions with stored credentials: Mastercard requires the Transaction Initiation Indicator for credit and debit card purchases using stored card data. The goal is to indicate whether the transaction was initiated by the cardholder (Cardholder-Initiated Transaction - CIT) or by the merchant (Merchant-Initiated Transaction - MIT). In this scenario, it is mandatory to send the
InitiatedTransactionIndicatornode with theCategoryandSubCategoryparameters for Mastercard transactions, within thePaymentnode. Check the example of the node and the list of categories and subcategories in Mastercard Transaction Initiator Indicator . - The
Payment.ServiceTaxAmountfield is exclusive to airlines and travel agencies, allowing them to charge the boarding fee separately from the airfare. - 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.
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".
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 | Size |
|---|---|---|---|
| Authorization number, identical to NSU | string | 6 |
| Acquirer transaction identifier | string | 20 |
| Authorization code | string | 6 |
| Payment identification number. | GUID | 36 |
| Transaction Status. See the complete table of transactional status. | byte | |
| Return code | string | 32 |
| Return message | string | 512 |
| Indicates which order number was sent to the acquirer.
| GUID | |
| Brand return code that defines the retry period. Valid only for Mastercard brand. Learn more about card brands retry programs | string | 2 |
| Returns "true" if the Void Guarantee is enabled and an error occurs during authorization (status Not Finalized - "0"). | boolean | |
| PAR (Payment Account Reference) is the number that associates different tokens to the same card. It will be returned by Master and Visa card brands and passed on to Cielo e-commerce clients. If the card brand does not send the information, the field will not be returned. | string | 29 |