Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Withdrawals

Get withdrawal requests

Retrieves a list of all withdrawal requests created by users as part of your participant. Results are limited to the last 2 months.

get/withdrawals/requests

Query parameters

participant_codestring

Filters for withdrawal request by a specific participant_code

pagestring

Filters for a specific page (pagination)

status'PENDING' | 'APPROVED' | 'REJECTED' | 'SETTLED'

Filter for a specific withdrawal status. Must be provided in upper case.

gas_pricestring

Filter for a specific gas_price value. Applies only to ERC-20 withdrawals.

client_withdrawal_request_idstring

Filter for client withdrawal request id

requested_timestamp[gt]string

Filter for withdrawal requests whose requested_timestamp is greater than the given Unix timestamp (in milliseconds).

requested_timestamp[gte]string

Filter for withdrawal requests whose requested_timestamp is greater than or equal to the given Unix timestamp (in milliseconds).

requested_timestamp[e]string

Filter for withdrawal requests whose requested_timestamp equals the given Unix timestamp (in milliseconds).

requested_timestamp[lt]string

Filter for withdrawal requests whose requested_timestamp is less than the given Unix timestamp (in milliseconds).

requested_timestamp[lte]string

Filter for withdrawal requests whose requested_timestamp is less than or equal to the given Unix timestamp (in milliseconds).

on_chain_status'PENDING' | 'CONFIRMED'

Filter for on-chain status

account_labelstring

Filter for a specific account label

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of withdrawal requests with optional filters: participant_code, page, status, gas_price, client_withdrawal_request_id, requested_timestamp, on_chain_status, account_label.

pagenumber
page_sizenumber
total_pagesnumber
countnumber

Example response

{
  "message": [
    {
      "id": "9084dd8f-ab9f-4f9b-a22b-49bdb4915a93",
      "withdrawal_account_id": 3709509,
      "participant_code": "ABCDEF",
      "requestor_participant_code": "ABCDEF",
      "requested_amount": "0.1004142",
      "settled_amount": "0.100414200000000000",
      "status": "APPROVED",
      "asset": "BTC",
      "account_group": "00SCXM",
      "transaction_id": "0x0c36fd59b0f48257b5cd02cdf23fd8fb8230e27c5ddd28ce02c8a6a4736da4e6",
      "requested_timestamp": 1777830138534,
      "created_timestamp": "2026-05-03T17:40:10.733Z",
      "client_withdrawal_request_id": "20aed707-3127-427d-a47e-97efc6470cb3",
      "on_chain_status": "CONFIRMED",
      "fee_amount": "0.000004021417575",
      "withdrawal_fee": "0",
      "amount_in_usd": 234.32708342365032,
      "recipient_instructions": "Invoice #123"
    }
  ],
  "page": 1,
  "page_size": 15,
  "total_pages": 1,
  "count": 1
}