VIP Preferred

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

The Payments API cater to the following needs for VIP Preferred:

Typical Scenarios

VIP Preferred Payment

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. Since VIP Preferred is supported only via a hosted page, 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.

APIs to use: Payment Handles+ Payments

VIP Preferred Withdrawal

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. This Payment Handle should immediately have the status of PAYABLE
  3. Use the paymentHandleToken returned in the response to process the Withdrawal request.

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

APIs to use: Payment Handles+ Standalone Credits

VIP Preferred Withdrawal (with risk checks)

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

  1. Make a Verification API call:

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

      1. You can use either 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.

  2. Conduct risk checks at your end. Once risk checks are done, 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. 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.

APIs to use: Verification API+ Standalone Credit API

VIP Preferred Registration

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

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

Add an Account

When you want to allow customer to add new account, do the following:

  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.

Delete an account

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

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

  2. On successful processing, account will be removed.

Did you find this page useful?