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

Step 1: Initial authentication with Paysafe 3D Secure REST API:

• Set the authenticationPurpose to RECURRING_TRANSACTION.

• Set the requestorChallengePreference to

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

  • CHALLENGE_REQUESTED for cards that are issued in a non-regulated 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 with the necessary details.

• Include the card details or the payment token if Customer Vault API is being used.

• Fill in the other applicable details for the authentication request and proceed with it.

Step 2: Initial authorization or card verification request with Paysafe Cards API, once the authentication request is completed and is successful:

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

• Include the card details or the payment token from the Customer Vault API with which the authentication was processed.

• 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. 

Initiate an authorization request to the Paysafe Cards 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 card details or the payment token with which the initial authorization was processed.

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

Step 1: Initial authentication with Paysafe 3D Secure REST API:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

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

  • CHALLENGE_REQUESTED for cards that are issued in a non-regulated 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 with the necessary details.

• Include the card details or the payment token if Customer Vault API is being used.

• Fill in the other applicable details for the authentication request and proceed with it.

Step 2: Initial authorization or card verification request with Paysafe Cards API, once the authentication request is completed and is successful:

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

• Include the card details or the payment token from the Customer Vault API with which the authentication was processed.

• 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. 

Initiate an authorization request to the Paysafe Cards 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 card details or the payment token with which the initial authorization was processed.

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

Step 1: Initial authentication with Paysafe 3D Secure REST API:

• Set the authenticationPurpose to INSTALMENT_TRANSACTION.

• Set the requestorChallengePreference to

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

  • CHALLENGE_REQUESTED for cards that are issued in a non-regulated 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 installment payments.

• Set the billingCycle with the necessary details.

• Set the maxAuthorizationsForInstalmentPayment with the appropriate value.

• Include the card details or the payment token if Customer Vault API is being used.

• Fill in the other applicable details for the authentication request and proceed with it. 

Step 2: Initial authorization or card verification request with Paysafe Cards API, once the authentication request is completed and is successful:

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

• Include the card details or the payment token from the Customer Vault API with which the authentication was processed.

• 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.

Initiate an authorization request to the Paysafe Cards 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 card details or the payment token with which the initial authorization was processed.

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

Step 1: Initiate an authentication with Paysafe 3D Secure REST API:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_REQUESTED 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.

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

• Include the card details or the payment token (from Customer Vault API) with which the initial authorization was processed.

• Fill in the other applicable details for the authentication request and proceed with it.

Step 2: Proceed with authorization with Paysafe Cards API, once the authentication request is completed and is successful:

• Add the storedCredential object to the authorization with type set to ADHOC, occurrence set to INITIAL.

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

Step 3: Profile creation in the Customer Vault, once the authorization request is completed and is successful:

• Create customer profile.

• Add customer address.

• Add the card to the customer profile.

Step 1: Retrieve the customer profile and the associated cards from the Customer Vault API. 

Step 2: Initiate an authentication with Paysafe 3D Secure REST API:

• Set the authenticationPurpose to PAYMENT_TRANSACTION.

• Set the requestorChallengePreference to

  • CHALLENGE_REQUESTED 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.

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

• Include the card details or the payment token (from Customer Vault API) with which the initial authorization was processed.

• Fill in the other applicable details for the authentication request and proceed with it.

Step 3: Authorization with Paysafe Cards API, once the authentication request is completed and is successful:

• Add the storedCredential object to the authorization 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 card details or the payment token from the Customer Vault API with which the authentication was processed.

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

Merchants can 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.