Recurrence

Unlike traditional credit card payments, recurring payments are automatically repeated at set periods and intervals, always charging the same amount to the same card or accoun

Recurring billing is widely used for magazine subscriptions, monthly fees, software licenses, and similar services. In addition to technical integration, your merchant must be enabled by the acquirer to accept recurring payments.

The merchant has advanced features to model billing according to its business needs, such as: setting and changing frequency, start and end dates, number of retry attempts, and interval between attempts.

⚠️

Warning: Cartão Protegido does not store the card CVV.

Therefore:

• The shopper must enter the CVV for each transaction, or;
• Your merchant can process transactions without CVV if authorized by the acquirer.

ℹ️

For security reasons, recurrence is only possible for cards that pass the Luhn Algorithm check, also known as "mod10".

To submit a recurring transaction, send the request according to the guidelines in this section. The split request for a recurring transaction must occur in the post-transactional stage.

It is not possible to request the split of a recurring transaction during the transactional 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.

⚠️

Warning: Don't send the value of the IssuerTransactionId in the TransactionLinkId parameter, or the value of the TransactionLinkId in the IssuerTransactionId parameter. The identifiers aren't interchangeable, and swapping them can affect the sale's conversion with the card brand.

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.

TLID Mastercard

The Transaction Link Identifier (TLID), sent and returned in the TransactionLinkId field, is a unique identifier generated by the Mastercard card brand during a transaction. It is created in the CIT transaction and must be sent, together with the IssuerTransactionId, to associate all subsequent transactions (MIT) within the same cycle.

See more details in Card Brand Identifiers.

Recurring transaction notifications

If the merchant configures a notification URL in the Notification Post, it receives a notification for each transaction generated by the recurrence engine, as shown in the following example.

{
   "RecurrentPaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
   "ChangeType": 2,
   "PaymentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}