Worldline | Store a card

Card-On-File (COF)

Card information of a cardholder can be tokenized and stored in a secure environment to facilitate a smooth & quick checkout process. Once stored, these stored card credentials otherwise known as Card-On-File (COF) can be used for subsequent transactions.

Storing a card credentials can be flagged during

an authorization (or)
an account verification .

Flag initial Card-On-File transactions

In your create payment request, you must include cardPaymentData.cardOnFileData object and associated properties.

Field	Remark
isInitialTransaction	Set to "true" to indicate that the transaction is an initial COF transaction.
initialCardOnFileData.transactionType	Indicate the type of the initial COF transaction using any of the appropriate values UNSCHEDULED_CARD_ON_FILE - An initial transaction initiated by the cardholder to store the credentials for future customer initiated transactions in the form of one-click payment during check-out. MERCHANT_INSTALLMENT - An initial transaction initiated by the cardholder to store the credentials to enable the merchant to charge the card towards installment repayments. RECURRING_FIXED - An initial transaction initiated by the cardholder to store the credentials to enable the merchant initiated recurring payments (fixed amount) in future. RECURRING_VARIABLE - Same as above but for variable amount.
initialCardOnFileData.futureUse	Use this to indicate the type of COF transactions expected to be performed referring to this initial transactions. Possible values are MERCHANT_INITIATED - Default. Use this if the credentials are being stored for future MITs. CARDHOLDER_INITIATED - Use this if the credentials are being stored for future CITs.

Field

Remark

isInitialTransaction

Set to "true" to indicate that the transaction is an initial COF transaction.

initialCardOnFileData.transactionType

Indicate the type of the initial COF transaction using any of the appropriate values

UNSCHEDULED_CARD_ON_FILE - An initial transaction initiated by the cardholder to store the credentials for future customer initiated transactions in the form of one-click payment during check-out.
MERCHANT_INSTALLMENT - An initial transaction initiated by the cardholder to store the credentials to enable the merchant to charge the card towards installment repayments.
RECURRING_FIXED - An initial transaction initiated by the cardholder to store the credentials to enable the merchant initiated recurring payments (fixed amount) in future.
RECURRING_VARIABLE - Same as above but for variable amount.

initialCardOnFileData.futureUse

Use this to indicate the type of COF transactions expected to be performed referring to this initial transactions. Possible values are

MERCHANT_INITIATED - Default. Use this if the credentials are being stored for future MITs.
CARDHOLDER_INITIATED - Use this if the credentials are being stored for future CITs.

Make sure to set the appropriate value for initialCardOnFileData.transactionType based on subsequent transaction types that you would like to initiate in future by referring to this transaction.

You cannot initiate a subsequent MIT/recurring payment by referring to an initial COF transaction completed with initialCardOnFileData.transactionType "UNSCHEDULED_CARD_ON_FILE".

Also an initial COF transaction with initialCardOnFileData.futureUse set to "CARDHOLDER_INITIATED" cannot be linked/referred for subsequent Merchant Initiated Transactions (MITs) and vice versa.

Below code snippet shows the cardOnFileData fields for initial COF transaction that needs to be included in the authorization request.

{
    "cardPaymentData": {
        "cardOnFileData": {
            "isInitialTransaction": true,
            "initialCardOnFileData": {
                "transactionType": "UNSCHEDULED_CARD_ON_FILE",
                "futureUse": "CARDHOLDER_INITIATED"
            }
        }
    }
}

It is important to store the references.schemeTransactionId returned in the response and supply it in the subsequent customer initiated or merchant initiated COF transactions.