Powered by Redocly

Fiat withdrawal

This section provides endpoints to manage and retrieve information about user fiat withdrawals.

List Withdrawals

Filter value. For DR (date range) this should be a JSON object with from and to ISO timestamps. Must be URL-encoded in the actual request.

Request
query Parameters
limit
integer >= 1
Default: 10

Number of results to return per request (max 100). Default 10.

Example: limit=25
offset
integer >= 0
Default: 0

Number of results to skip (pagination). Default 0.

sB
string
Default: "created_at"

Field to sort by. Default created_at.

Example: sB=created_at
sD
string
Default: "desc"

Sort direction. Default desc.

Enum: "asc" "desc"
Example: sD=desc
fB
required
string

Field name to filter by (e.g. updated_at).

Example: fB=updated_at
fT
required
string

Filter field type. D=Date, S=String, N=Number, E=Enum.

Enum: "D" "S" "N" "E"
Example: fT=D
fO
required
string

DR=Date Range, D=Single day.

Enum: "DR" "D"
Example: fO=DR
fV
required
string

Filter value. For DR (date range) this should be a JSON object with from and to ISO timestamps. Must be URL-encoded in the actual request.

Example: fV={"from":"2025-12-01T00:00:00.000Z","to":"2025-12-04T23:59:59.000Z"}
Responses
200

List of withdrawals retrieved successfully

get/withdrawals
Response samples
application/json
{
  • "api_message": "WITHDRAWAL_GET_LIST_SUCCESS",
  • "api_data": {
    }
}

Create Withdrawal

Creates a new withdrawal request.

Request
Request Body schema: application/json
required
amount
required
string

Requested withdrawal amount (before fees), as string.

currency
required
string
currency_id
required
string
bank_account_id
required
string
Responses
200

Withdrawal successfully created

post/withdrawals
Request samples
application/json
{
  • "amount": "1158",
  • "currency": "USD",
  • "currency_id": "bkE0RmNjbEhCUmc9",
  • "bank_account_id": "OE9Dam9zR0ZiNk09"
}
Response samples
application/json
{
  • "api_message": "WITHDRAWAL_POST_SUCCESS",
  • "api_data": {
    }
}

Show Withdrawal

Returns details of a specific withdrawal request.

Request
path Parameters
withdrawal_id
required
string

ID of the withdrawal

Responses
200

Withdrawal details retrieved successfully

get/withdrawals/{withdrawal_id}
Response samples
application/json
{
  • "api_message": "WITHDRAWAL_GET_SHOW_SUCCESS",
  • "api_data": {
    }
}

Update Withdrawal

Updates the status of a specific withdrawal request.

Request
path Parameters
withdrawal_id
required
string

ID of the withdrawal

Request Body schema: application/json
required
status
string
remarks
string
otp
string
Responses
200

Withdrawal updated successfully

put/withdrawals/{withdrawal_id}
Request samples
application/json
{
  • "status": "ADMIN_APPROVED",
  • "remarks": "approve 1",
  • "otp": "164209"
}
Response samples
application/json
{
  • "api_message": "WITHDRAWAL_PUT_SUCCESS",
  • "api_data": {
    }
}
➔ Next to Webhooks