Recurring payment
When a merchant triggers a Card-On-File transaction following a fixed/regular schedule then it is termed as Scheduled Card-On-File Merchant-Initiated Transaction or simply as Recurring Payment . These recurring transactions can be triggered for fixed amounts or variable amounts depending on the business needs.
Fixed amount - Charging a cardholder a fixed amount for a music or any other subscription services or towards a installment payment.
Variable amount - Charging a cardholder for a variable amount typically for pay-per use services like utility services.
Initiate a recurring payment
To initiate a recurring payment, you must include cardPaymentData.cardOnFileData object and associated properties in your create payment request.
Property |
Explanation |
|---|---|
isInitialTransaction |
Set to " false " to indicate that the transaction is a subsequent transaction referring to an initial Card on File transaction |
subsequentCardOnFileData.cardOnFileInitiator |
Initiator of the subsequent COF transaction, it must be "MERCHANT" |
subsequentCardOnFileData.transactionType |
Indicate the type of the subsequent MIT (recurring) using any of the appropriate values
|
subsequentCardOnFileData.initialSchemeTransactionId |
Provide the schemeTransactionId obtained as part of approved initial COF transaction, used for identify & linking a transaction through its lifecycle. |
Below code snippet shows the cardPaymentData.cardOnFileData properties for recurring payment with variable amount "RECURRING_VARIABLE" initiated to charge the cardholder towards a subscription fee.
{
"cardPaymentData": {
"cardOnFileData": {
"isInitialTransaction": false,
"subsequentCardOnFileData": {
"cardOnFileInitiator": "MERCHANT",
"transactionType": "RECURRING_VARIABLE",
"initialSchemeTransactionId": "304232535995347"
}
}
}
}These transactions are out of scope of SCA as the cardholder is not available to complete an authentication.