Skip to main content

Create a Payment Handle

POST 
/v1/paymenthandles

Paysafe Embedded Wallet leverages PaymentHandle to initiate deposit and withdrawal operations.

  • Deposits - correspond to paymentType=PAYMENT
  • Withdrawals - correspond to paymentType=STANDALONE_CREDIT
  • For all Paysafe Wallet operations the additional wallet property is required to be present.

A Payment Handle represents tokenized information about the payment method that you set up for your customer. Once the Payment Handle is created, you can then include the paymentHandleToken returned in the Payment Handle request response in a new payment request.

Note: A Payment Handle can be used in a Payment request only if it has the status of PAYABLE.

  • A Payment Handle for a standard credit card deposit
  • A Payment Handle for a credit card deposit that is registered for 3D Secure - the response for this request will contain a redirect to present to the customer so they can validate their 3D Secure credentials
  • A Payment Handle for a credit card withdraw (Standalone Credit)
  • A Payment Handle for a RapidTransfer deposit

Note: The status of Payment Handles will remain INITIATED for the following cases:

  • When the customer is redirected to a redirect_payment URL until the customer verifies the payment instrument.
  • When the requested amount is more than the maximum amount configured in the Business Portal.
  • When Alternate Payment Methods like RapidTransfer, Paysafecash are selected by the customer.

Request​

Responses​

Created
Response Headers
  • Content-Type string