Create a User Withdrawal

User withdrawal

post

This API endpoint allows users to initiate a withdrawal request to transfer funds from user account to an personal wallet address. The withdrawal requires specifying the amount, currency type, destination wallet, and user identification for processing.

Body

application/json

Request to withdraw funds

amountstring · decimalRequired

Amount to withdraw, we support high precision due to certian tokens

currency_idstringRequired

Currency ID, which can be retrieved using supported currencies.

user_reference_idstringRequired

The unique user reference to identify a user for transaction tracking

wallet_addressstringRequired

Destination wallet address for withdrawal

Responses

200

User withdrawal

application/json

Response for withdraw request

amountstringRequired

Withdrawal amount

currencystringRequired

Currency name

requires_approvalbooleanOptional

Whether transaction requires approval

statusstringRequired

Transaction status

wallet_addressstringRequired

Destination wallet address

422

Validation error

application/json

post

/v1/user/withdraw

HTTPcURLJavaScriptPython

POST /v1/user/withdraw HTTP/1.1
Host: gateway.stage.pay.io
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "amount": "100.50",
  "currency_id": "c872e749-fd56-533e-b01f-de87ae38e7f1",
  "user_reference_id": "hub_player_2",
  "wallet_address": "0x1234567890123456789012345678901234567890"
}

{
  "amount": "100.50",
  "currency": "USDC",
  "requires_approval": false,
  "status": "Processing",
  "wallet_address": "0x1234567890123456789012345678901234567890"
}