POST
/
api
/
platform
/
withdrawals
/
withdraw-fund
/
{user_id}
Withdraw Fund
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/withdrawals/withdraw-fund/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '{
  "amount": 123,
  "memo": "<string>",
  "transfer_method": "bank_withdrawal",
  "bank_id": "<string>",
  "card_id": "<string>"
}'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "user_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transfer_method": "bank_withdrawal",
    "withdrawal_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "amount_credited": 123,
    "processing_fees": 123,
    "memo": "<string>",
    "status": "pending",
    "failed_reason": "<string>"
  },
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

​
X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the user initiating the withdrawal.

Body

application/json
​
amount
number
required

Amount to withdraw from the wallet

​
transfer_method
enum<string>
required

Withdrawal method (e.g., CARD, ACH)

Available options:
bank_withdrawal,
card_withdrawal
​
memo
string | null

Optional note or comment for the withdrawal

Maximum length: 255
​
bank_id
string | null

Bank account ID to withdraw to (if using ACH)

​
card_id
string | null

Card ID to withdraw to (if using CARD method)

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

​
data
object | null

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1756883312.350897

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400