Skip to main content

Create Withdrawal

POST 
/v2/customers/:customerId/withdrawals

Create withdrawal for the current customer.

Withdrawals are created in PREVIEW state.

The following parameters are required:

  • currency - withdrawal currency
  • amount - withdrawal amount in currency minor units
  • paymentOption - withdrawal payment option must be one of the available payment options provided by GET /profile/withdrawals/options
  • paymentInstrumentReference - provide reference to existing verified payment instrument provided by GET /profile/instruments
  • deviceInfo - should provide valide appType and profiling session id.

Optional parameters:

  • merchantRefNum - should be provided by the partner if he desires to match with objects in his backend system.

Withdrawals in PREVIEW state do not create actual transaction in Paysafe Wallet system. It allows to check withdrawal parameters and display the fees.

To move the payment forward you must request status change using POST /profile/withdrawals/{withdrawalId}/status. This will perform the required validations and move the withdrawal in PENDING state.

{
   "status": "PENDING"
}

To confirm the withdrawal for execution use POST /profile/withdrawals/{withdrawalId}/status:

{
   "status": "PROCESSING"
}

Request​

Responses​

Created