Setup and process payment plan - Hosted Solutions

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

• Set authenticationPurpose to be RECURRING_TRANSACTION or PAYMENT_TRANSACTION.
• Set requestorChallengePreference to
  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are mandatory to pass 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 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. The field is required if authenticationPurpose is set to RECURRING_TRANSACTION. 

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.

Note that SCA exemptions cannot be used for establishment of recurring payment plan.

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

• Add the storedCredential object to the authorization with the appropriate type (RECURRING, TOPUP or 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. 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. 
• The payment plan is established upon successful authorization request, and you may now proceed to processing a subsequent payment. 

Process Merchant-Initiated Credentials-On-File (RECURRING and TOPUP) transactions 

• Initiate an authorization request to the Paysafe Payments API.
• Include the ‘storedCredential’ object with type (RECURRING or 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. 

Process Adhoc Cardholder-Initiated Credentials-On-File transactions

To process a subsequent customer-initiated credentials-on-file subsequent 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.