Warning

• In a standard debit card transaction (with authentication), send Authenticate = "true".
• Mastercard debit 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 InitiatedTransactionIndicator node with the Category and SubCategory parameters for Mastercard transactions, within the Payment node. Check the list of categories in the Category parameter description and the complete table of subcategories in Mastercard Transaction Initiation Indicator.
• It is not possible to perform a transaction with an Amount = 0. To verify if a card is valid, use Zero Auth.
• 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.
• The order identification number (MerchantOrderId) does not change throughout the transaction flow. However, a new number (SentOrderId) may be generated for the order and used during the transaction. This number will only differ if:
  • the MerchantOrderID sent is outside the expected format for the field or has more than 20 characters;
  • the MerchantOrderID sent has already been used in the last 24 hours.

ℹ️

Important

The validation and return of the Payment.Eci field occur only in the production environment at this initial stage.

Stored credential transaction identifiers

According to card brand rules, recurring transactions require sending identification fields that link each charge to the original CIT transaction: the IssuerTransactionId (all card brands) and the TransactionLinkId (Mastercard). In merchant recurrence, also send the Payment.OriginalRecurrentAmount. In scheduled recurrence, the IssuerTransactionId and TransactionLinkId fields are sent automatically in subsequent transactions.

Card brand identifier: IssuerTransactionId

The card brand identifier (IssuerTransactionId) is a code returned in the response of the CIT transaction or of the card verification (Zero Auth), and it must be sent in subsequent recurring transactions of all card brands. See more details in Card Brand Identifiers.

Cancellation guarantee

When a transaction returns with the status Not Finalized and the Void Guarantee feature is enabled for the merchant, do not reuse the same MerchantOrderID value in new transaction attempts.

For subsequent attempts, generate a new order identifier. Resubmitting a transaction using the same MerchantOrderID from an attempt that returned as Not Finalized can cause processing errors.

Debit card transaction response

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