Credentials-On-File payments - Hosted Solutions

Step 1: Tokenize in Paysafe JS or Setup in Paysafe Checkout with threeDs object:

• Set the authenticationPurpose to RECURRING_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are required to pass an authentication challenge for establishing a payment plan.

  • CHALLENGE_REQUESTED for cards that are issued outside of the EU/UK region, if you want the cardholders to undergo an authentication challenge. Although authentication may not be mandatory, it has the potential to improve the acceptance rate of the subsequent payments.

• Set the billingCycle with the necessary details.

Fill in the other applicable details and proceed with the API request. Once the Payment Handle is created successfully, you will receive the token via an API response.

Step 2: Proceed with initial authorization, once the Payment Handle has been created successfully:

• Add the storedCredential object to the authorization with type set to RECURRING and occurrence set to INITIAL to indicate the initial payment.

• Include the appropriate Payment Handle token.

• Fill in the other necessary details for the authorization request and proceed with it.

If you receive a successful payment response, you must store the Transaction ID in your back office, as you must supply it in the field initialTransactionId (storedCredential object) with each subsequent merchant-initiated rebilling for the same payment plan.

Step 3: Create a customer profile and save the payment method.

Initiate an authorization request to the Paysafe Payments API and:

• Include the storedCredential object with type set to RECURRING, occurrence set to SUBSEQUENT and initialTransactionId. The initialTransactionId is the Paysafe Transaction ID that was returned to you with the initial authorization confirmation. If the initial authorization was processed outside of the Paysafe environment, you can supply the Scheme Transaction ID of the initial authorization in field externalInitialTransactionId.

• Include the multi-use Payment Handle token that was used for the creation of the payment plan from the Card Saving process.

• Fill in the other necessary details for the authorization request and proceed with it.

Step 1: Tokenize in Paysafe JS or Setup in Paysafe Checkout with threeDs object:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are mandatory to pass an authentication challenge for establishing a payment plan.

  • CHALLENGE_REQUESTED for cards that are issued outside of the EU/UK region, if you want the cardholders to pass an authentication challenge. Although authentication may not be mandatory, it has the potential to improve the acceptance rate of the subsequent payments.

Fill in the other applicable details and proceed with the API request. Once the Payment Handle is created successfully, you will receive the token via an API response.

Step 2: Proceed with initial authorization, once the Payment Handle has been created successfully:

• Add the storedCredential object to the authorization with type set to TOPUP and occurrence set to INITIAL to indicate the initial payment. 

• Include the appropriate Payment Handle token.

• Fill in the other necessary details for the authorization request and proceed with it.

If you receive a successful payment response, you must store the Transaction ID in your back office, as you must supply it in the field initialTransactionId (storedCredential object) with each subsequent merchant-initiated rebilling for the same payment plan. 

Step 3: Create a customer profile and save the payment method.

Initiate an authorization request to the Paysafe Payments API and:

• Include the storedCredential object with type set to TOPUP, occurrence set to SUBSEQUENT and initialTransactionId. The initialTransactionId is the Paysafe Transaction ID that was returned to you with the initial authorization confirmation. If the initial authorization was processed outside of the Paysafe environment, you can supply the Scheme Transaction ID of the initial authorization in field externalInitialTransactionId.

• Include the multi-use Payment Handle token that was used for the creation of the payment plan from the Card Saving process.

• Fill in the other necessary details for the authorization request and proceed with it.

Step 1: Tokenize in Paysafe JS or Setup in Paysafe Checkout with threeDs object:

• Set the authenticationPurpose to INSTALMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are mandatory to pass an authentication challenge for establishing a payment plan.

  • CHALLENGE_REQUESTED for cards that are issued outside of the EU/UK region, if you want the cardholders to pass an authentication challenge. Although authentication may not be mandatory, it has the potential to improve the acceptance rate of the subsequent payments.

• Set the billingCycle.

• Set the maxAuthorizationsForInstalmentPayment.

Step 2: Proceed with initial authorization, once the Payment Handle has been created successfully:

• Add the storedCredential object to the authorization with type set to INSTALLMENT and occurrence set to INITIAL to indicate the initial payment.

• Include the appropriate Payment Handle token.

• Fill in the other necessary details for the authorization request and proceed with it.

If you receive a successful payment response, you must store the Transaction ID in your back office, as you must supply it in the field initialTransactionId (storedCredential object) with each subsequent merchant-initiated rebilling for the same payment plan.

Step 3: Create a customer profile and save the payment method. 

Initiate an authorization request to the Paysafe Payments API and:

• Include the storedCredential object with type set to INSTALLMENT, occurrence set to SUBSEQUENT and initialTransactionId. The initialTransactionId is the Paysafe Transaction ID that was returned to you with the initial authorization confirmation. If the initial authorization was processed outside of the Paysafe environment, you can supply the Scheme Transaction ID of the initial authorization in field externalInitialTransactionId.

• Include the multi-use Payment Handle token that was used for the creation of the payment plan from the Card Saving process.

• Fill in the other necessary details for the authorization request and proceed with it.

Step 1: Tokenize in Paysafe JS or Setup in Paysafe Checkout with threeDs object:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_REQUESTED for cards that are issued outside of the EU/UK region, if you want the cardholders to pass authentication challenge. Although authentication may not be mandatory, it has the potential to improve the acceptance rate of the subsequent payments.

  • NO_PREFERENCE if you don't have preferences around the authentication flow.

Fill in the other applicable details and proceed with the API request. Once the Payment Handle is created successfully, you will receive the token via an API response.

Step 2: Proceed with initial authorization, once the Payment Handle has been created successfully:

• Add the storedCredential object to the authorization with the type set to ADHOC and occurrence set to INITIAL to indicate the initial payment.

• Include the appropriate Payment Handle token.

• Fill in the other necessary details for the authorization request and proceed with it.

Step 3: Create a customer profile and save the payment method.

To process a subsequent customer-initiated Credentials-On-File request you will need to refer to the typical scenario for existing customers and:

• Save Cards and Addresses for Paysafe Checkout

• or the Saved Cards Integration for Paysafe JS. 

Merchants have the ability to process both customer-initiated transactions and merchant-initiated transactions for a cardholder with the same or different cards.

Below are examples of possible combinations. The detailed processing is outlined in the above sections.