Credit card

ℹ️

Please refer to the API Reference for the full request and response examples.

To use all the features available in our API, it is important that you first understand the concepts around processing a credit card transaction.

ConceptDescription
AuthenticationThe authentication process makes it possible to effective a sale, which will pass through the authentication process of the card issuing bank, then providing more security for the sale and transferring the risk of fraud to the bank.
AuthorizationThe authorization (or pre-authorization) is the main operation in the eCommerce, because through it, the sale can be finished. Pre-authorization only sensitizes the customer's limit, but still does not generate charge for the consumer.
CaptureWhen making a pre-authorization, it is necessary to confirm it, so that the charge is effected to the card carrier. It is through this operation a pre-authorization is effected, and it can be executed normally within 5 days after the pre-authorization date.
CancellationThe cancellation is necessary when, for some reason, a sale will not be effected anymore.

ℹ️

Important

The order identification number (MerchantOrderId) does not change, remaining the same throughout the transactional flow. However, an additional number can be generated for the order and used during the transaction. This number will only be different in case of adaptation to the acquirer's rules or in case there are repeated order identification numbers (MerchantOrderId) in less then 24 hours. For reconciliation purposes, use TransactionId.

The transaction capture can be authomatic or posterior:

  • Authomatic capure: send the Payment.Capture parameter in the request as “true”.
  • Posterior capture: send Payment.Capture as "false" and then do the capture request.

⚠️

Validating a card

A transaction with its value (Amount) as 0 is not allowed. To verify if a card is valid, use Zero Auth.

Credit card authentication

Please refer to Credit card with authentication to create an authenticated credit card transaction.

Mastercard credit card transactions with stored credentials

Mastercard brand requires the Transaction Initiator Indicator for credit and debit card transactions using stored card data.

The goal is to indicate if the transaction was initiated by the cardholder or by the merchant. In this scenario, the node InitiatedTransactionIndicator must be sent with the parameters Category and SubCategory for Mastercard transactions, within the Payment node.

Please check the complete list of categories in the Category parameter description and the subcategories tables in Transaction Indicator Tables.