Credentials-On-File payments - Server-To-Server

Step 1: Set the proper authentication details in the threeDs object when creating a Payment Handle during the Card Saving process:

• Set the authenticationPurpose to RECURRING_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are required to pass the 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 not mandatory, authentication can improve acceptance rates for subsequent payments.

• Set the billingCycle with the necessary details.

Fill in the other applicable details for the Payment Handle creation request and proceed with it.

Step 2: Proceed with initial authorization or a card verification request, 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 initialTransactionId field of the storedCredential object with each subsequent merchant-initiated rebilling for the same payment plan.

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 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: Set the proper authentication details in the threeDs object when creating a Payment Handle during the Card Saving process:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are required 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 not mandatory, authentication can improve acceptance rates for subsequent payments.

Fill in the other applicable details for the Payment Handle creation request and proceed with it.

Step 2: Proceed with initial authorization or a card verification request, 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 initialTransactionId field of the storedCredential object with each subsequent merchant-initiated rebilling for the same payment plan.

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 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: Set the proper authentication details in the threeDs object when creating a Payment Handle during the Card Saving process:

• Set the authenticationPurpose to INSTALMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_MANDATED for EU/UK issued cards, as the cardholders are required 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 not mandatory, authentication can improve acceptance rates for subsequent payments.

• Set the billingCycle.

• Set the maxAuthorizationsForInstalmentPayment.

Fill in the other applicable details for the Payment Handle creation request and proceed with it.

Step 2: Proceed with initial authorization or a card verification request, 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 initialTransactionId field of the storedCredential object with each subsequent merchant-initiated rebilling for the same payment plan.

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 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: Set the proper authentication details in the threeDs object when creating a Payment Handle during the Card Saving process:

• 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 not mandatory, authentication can improve acceptance rates for subsequent payments.

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

Fill in the other applicable details for the Payment Handle creation request and proceed with it.

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: Save the card against a customer profile

This step is optional and not needed if you’re storing the payment information on your premises.

Step 1: Retrieve customer profile information and available payment methods. 

Step 2: Proceed with creation of single-use Payment Handle created from multi-use Payment Handle.

In the threeDs object:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • NO_PREFERENCE if you don’t have preference if the cardholder should be challenged or not.

  • CHALLENGE_REQUESTED if you want the card issuing institution to challenge the cardholder authentication.

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

Step 3: Proceed with an authorization with the newly created single-use Payment Handle:

• Include the storedCredential object with type ADHOC, occurrence set to SUBSEQUENT and initialTransactionId. The initialTransactionId is the Paysafe Transaction ID that was returned to you with the initial authorization confirmation. 

• Include the single-use Payment Handle token.

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

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 the examples of possible combinations. The detailed processing is outlined in the above sections.