Use Case 2: Withdrawals

Call endpoint /paymenthub/v1/paymenthandles

• transactionType:  VERIFICATION
• paymentType:  PAY_BY_BANK

Pass the required parameters in the payByBank object.

If this is a new consumer, pass the required parameters in the billingDetails and profile objects.

Paysafe creates a payment handle and returns our standard gateway response, indicating either a positive or negative outcome:

Happy path: this is a returning consumer

Happy path: this is a new consumer

The payment handle status depends on the outcome of the request:

• For positive scenarios, the payment handle is created with status PAYABLE.
• For negative scenarios, the payment handle is created with status FAILED.

Call endpoint /paymenthub/v1/verifications using the paymentHandleToken.

• The payment handle status changes to COMPLETED.

Paysafe returns our verifications response, indicating that the request status is COMPLETED and providing a paymentHandleToken for each registered bank account.

Store the token (payByBank.achBankAccounts.paymentHandleToken) for later use.

payByBank.achBankAccounts.paymentHandleToken is a unique identifier for each bank account of the consumer and does not change. You subsequently use it to create a single-use payment handle token, which is used to make payments and withdrawals for each unique transaction.

Happy path: Paysafe returns the consumer's linked bank accounts

Call endpoint /paymenthub/v1/paymenthandles

• transactionType: STANDALONE_CREDIT
• paymentType: PAY_BY_BANK

Pass the required parameters:

• If this is a new consumer, pass the required parameters in the payByBank, profile and billingDetails objects.
• If this is a returning consumer, pass the required parameters in the payByBank object only.

Paysafe creates a payment handle and returns our standard gateway response, indicating either a positive or negative outcome:

Happy path: the returning consumer initiates a withdrawal

The payment handle status depends on the outcome of the request:

• For positive scenarios where this is either a new consumer or a returning consumer who is adding a new bank account, the payment handle is created with status INITIATED.
• For positive scenarios where an existing consumer is using an existing bank account, the payment handle is created with status PAYABLE.
• For negative scenarios, the payment handle is created with status FAILED.

Redirect the consumer to the URL provided in the payment handle response.

• The payment handle status changes to PROCESSING.

The consumer accepts the Terms & Conditions (T&Cs), selects the bank they want to add, and provides the credentials of the bank account to confirm linking it.

• The payment handle status changes to PAYABLE.

Paysafe returns our standard gateway response, indicating either a positive or negative outcome:

Happy path: the consumer is enrolled and the bank account is successfully added

Unhappy path: the consumer rejects the Terms & Conditions (T&Cs)

The payment handle status depends on the outcome of the request:

• For positive scenarios, the payment handle status changes to PAYABLE.
• For negative scenarios, the payment handle status changes to FAILED.

Call endpoint /paymenthub/v1/standalonecredits using the paymentHandleToken.

Paysafe returns our standard gateway response, indicating either a positive or negative outcome:

Positive outcome: Happy path

Negative outcomes: Unhappy path - the request fails

The payment handle status depends on the outcome of the request:

• For positive scenarios, the status first changes to PROCESSING and then to COMPLETED.
• For negative scenarios, the status changes to FAILED.
• For negative scenarios where the token expires after 15 minutes, the status changes to EXPIRED.

Following a successful withdrawal, the consumer receives email confirmation of the payout.