VIP Preferred

The Paysafe Payments API supports VIP Preferred as a Payment Instrument. You can process VIP Preferred payments using the Payments API.

When you want to process a VIP Preferred payment request, you would do the following:

1. Create a Payment Handle with the transactionType parameter set to PAYMENT and the paymentType parameter set to VIPPREFERRED.
2. Paysafe returns a response with the following:
   • The action parameter is set to REDIRECT
   • A payment_redirect link that points to the VIP Preferred hosted page URL
3. You can either embed the hosted page within your own custom checkout solution or redirect the customer to the hosted page URL on a different tab.
4. Interactions on the hosted page are handled by Paysafe and on successful payment, we will notify you on the on_completed parameter included with your request.
5. At this point, the status of the Payment Handle becomes PAYABLE.
6. Use the paymentHandleToken returned in the response to process the Payment request.

Once the Payment request is successfully completed, the funds are immediately transferred to the merchant's account.

1. Make a verification call:
   • Create a Payment Handle with the transactionType parameter set to VERIFICATION and the paymentType parameter set to VIPPREFERRED
   • You can use either registration id or SSN of the customer.
   • You will receive "paymentHandleToken" (called Payment Handle) in the response. The response should also have "status" (called Payment Handle Status) as PAYABLE.
   • Use the "paymentHandleToken" to process the Verification API.
   • In Verification API response, you will get status as COMPLETED, you will get bankToken for each registered account.
     • If user is not registered then you will get the status as FAILED.You can register user using Registration API.
   • Store the paymentToken at your end.
   • The BankToken (vippreferred.achBankAccounts.paymentHandleToken) is a unique identifier for each bank account of the user and remains same. The BankToken is later used to create a Single-Use Payment Handle Token which is used to make the payment for each unique transaction.
2. Create a Payment Handle with:
   • transactionType parameter set to PAYMENT and the paymentType parameter set to VIPPREFERRED.
   • Pass the registrationId or consumerid along with bankToken in the vippreferred object.
3. You will receive "paymentHandleToken" (called Payment Handle) in the response. The response should also have "status" (called Payment Handle Status) as PAYABLE.
4. Use the paymentHandleToken returned in the response of Payment Handle to process the Payment.

When you want to process a VIP Preferred withdrawal request, you would do the following:

1. Create a Payment Handle with the transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to VIPPREFERRED.
2. Paysafe returns a response with the following:
   • The action parameter is set to REDIRECT
   • A payment redirect link that points to the VIP Preferred hosted page URL
3. You can either embed the hosted page within your own custom checkout solution, or redirect the customer to the hosted page URL on a different tab.
4. Interactions on the hosted page are handled by Paysafe and on successful payment, we will notify you on the completed parameter included with your request.
5. At this point, the status of the Payment Handle becomes PAYABLE.
6. Use the paymentHandleToken returned in the response to process the Withdrawal request.
7. Once the Payment request is successfully completed, the funds are immediately transferred to the customer's account.

• When you want to apply own risk rules before withdrawal, you would do the following:

The BankToken (vippreferred.achBankAccounts.paymentHandleToken) is a unique identifier for each bank account of the user and remains same. The BankToken is later used to create a Single-Use Payment Handle Token which is used to make the payment for each unique transaction.

• Make a Verification API call:
  1. Create a Payment Handle with the transactionType parameter set to VERIFICATION and the paymentType parameter set to VIPPREFERRED.

     • You can either use registration id or SSN of the customer.

  2. This Payment Handle should immediately have the status of PAYABLE.

  3. Use the paymentHandleToken returned in the response to process the Verification request.

  4. In Verification API response, you will get paymentToken/bankToken for each registered account.

  5. Store the paymentsTokens at your end.

• Conduct risk checks at your end. Once risk checks are done, follow these steps:

  1. Create a Payment Handle with the transactionType parameter set to STANDALONE_CREDIT and the paymentType parameter set to VIPPREFERRED.

  2. Pass the paymentToken received in Verification API.

  3. This Payment Handle should immediately have the status of PAYABLE.

  4. Use the paymentHandleToken returned in the response to process the Withdrawal request.

  5. Once the Payment request is successfully completed, the funds are immediately transferred to the customer's account.

If you want to register a new customer, follow these steps:

1. Call the registration API by passing required customer details. A redirection link will be sent.

2. Open the redirection link in an iFrame.

3. Allow the customer to enter remaining details such as identity document in an iFrame.

4. Once the customer completes the flow in an iFrame successfully, the registration is done.

5. You can check registration status of the customer by making a get call on Registration API using registrationId.

If you want to register a new customer, you would do the following:

1. Call the registration API by passing required customer details. 
2. A response containing bank accounts and necessary details will be sent.
3. Once you get a successful response, the user will be registered.
4. You can check registration status of the customer by making a get call on Registration API using registrationId.

When you want to allow a customer to add a new account, follow these steps:

1. Call the add account API with required details such as account number, Bank Name and routing number.

2. On successful processing, new account will get added.

When you want to allow customer to remove the existing account, you would do the following:

1. Make a DELETE operation on an API with bank account number.

2. On successful processing, account will be removed.