List withdrawals

GET

/withdrawals

curl --request GET \
  --url 'https://example.com/v2/withdrawals?status=PENDING_APPROVAL&page=1&limit=20' \
  --header 'X-CowriePay-Key: <X-CowriePay-Key>'

• Current version

Returns paginated withdrawals for the workspace, ordered by request date descending. Includes idempotency_key in each item. Does not include fee_record, use GET /transactions/withdrawals for a view with fee records.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

status

string

Allowed values: PENDING_APPROVAL PENDING UNDER_REVIEW PROCESSING CONFIRMING CONFIRMED FAILED CANCELLED

Filter by withdrawal status

page

integer

default: 1 >= 1

Page number (1-based)

limit

integer

default: 20 >= 1 <= 100

Items per page (max 100)

Responses

200

Paginated withdrawal list

Media typeapplication/json

object

total

Total number of matching records

integer

page

Current page number

integer

limit

Items per page

integer

data

Array<object>

Withdrawal record as returned by GET /withdrawals. Includes idempotency_key; fee_record is not included in this view.

object

id

string format: uuid

chain

string

Allowed values: TRON_MAINNET TRON_TESTNET BSC_MAINNET BSC_TESTNET ETH_MAINNET ETH_TESTNET

asset

string

Allowed values: USDT_TRON USDT_BSC USDT_ETH USDC_ETH EURC_ETH ETH BNB

amount

Withdrawal amount in human-readable units. Example: “50.000000” for 50 USDT, “0.500000000000000000” for 0.5 ETH.

string

status

string

Allowed values: PENDING_APPROVAL PENDING UNDER_REVIEW PROCESSING CONFIRMING CONFIRMED FAILED CANCELLED

txid

Any of:

string

string

null

null

idempotency_key

string

requested_at

string format: date-time

confirmed_at

Any of:

string

string format: date-time

null

null

Example

{
  "data": [
    {
      "chain": "TRON_MAINNET",
      "asset": "USDT_TRON",
      "amount": "50.000000",
      "status": "PENDING_APPROVAL",
      "txid": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab"
    }
  ]
}

401

Invalid or revoked API key / HMAC signature mismatch

Media typeapplication/json

object

error

required

Human-readable message, for display/logging. Do NOT branch on this text.

string

code

required

Stable, machine-readable error code, branch on this, not the message. Common values: VALIDATION_ERROR, INVALID_JSON, PAYLOAD_TOO_LARGE, MISSING_AUTH_HEADERS, INVALID_SIGNATURE, TIMESTAMP_EXPIRED, REPLAY_DETECTED, INVALID_API_KEY, IP_NOT_ALLOWED, API_KEY_EXPIRED, WORKSPACE_INACTIVE, INSUFFICIENT_SCOPE, NOT_FOUND, CONFLICT, UNPROCESSABLE, INSUFFICIENT_BALANCE, INVALID_DESTINATION_ADDRESS, DESTINATION_IS_INTERNAL, CHAIN_NOT_ENABLED, FAUCET_ONLY_SANDBOX, FAUCET_ADDRESS_NOT_FOUND, FAUCET_INVALID_ASSET, FAUCET_AMOUNT_OVER_CAP, FAUCET_RATE_LIMITED, FAUCET_TOO_MANY_ITEMS, FAUCET_DUPLICATE_ASSET, FAUCET_NATIVE_REQUIRES_DEPOSIT, FAUCET_NATIVE_BUDGET_EXCEEDED, FAUCET_DISPENSER_EXHAUSTED, WITHDRAWAL_NOT_CANCELLABLE, IDEMPOTENCY_CONFLICT, IDEMPOTENCY_MISMATCH, IDEMPOTENCY_KEY_INVALID, FEATURE_NOT_AVAILABLE, RATE_LIMITED, DATABASE_ERROR, INTERNAL_ERROR, UNAUTHORIZED, FORBIDDEN, UNSUPPORTED_MEDIA_TYPE, WITHDRAWALS_FROZEN, WORKSPACE_NOT_FOUND, SYSTEM_WORKSPACE_PROTECTED, FAUCET_INVALID_AMOUNT, FAUCET_NO_ASSETS, FAUCET_NOT_SANDBOX. Most failures do NOT carry a business code. 326 throw sites raise a generic one (VALIDATION_ERROR, NOT_FOUND, UNPROCESSABLE, UNAUTHORIZED, CONFLICT, FORBIDDEN) against 46 named public codes, so a generic code is the common case and a named one is the exception. Branch on code; treat error as human text that may be reworded. The full catalogue, with causes and next steps, is the Error codes guide.

string

Example

{
  "error": "Insufficient balance. Available: 10.000000, Requested: 50.000000",
  "code": "INSUFFICIENT_BALANCE"
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

Human-readable message, for display/logging. Do NOT branch on this text.

string

code

required

Stable, machine-readable error code, branch on this, not the message. Common values: VALIDATION_ERROR, INVALID_JSON, PAYLOAD_TOO_LARGE, MISSING_AUTH_HEADERS, INVALID_SIGNATURE, TIMESTAMP_EXPIRED, REPLAY_DETECTED, INVALID_API_KEY, IP_NOT_ALLOWED, API_KEY_EXPIRED, WORKSPACE_INACTIVE, INSUFFICIENT_SCOPE, NOT_FOUND, CONFLICT, UNPROCESSABLE, INSUFFICIENT_BALANCE, INVALID_DESTINATION_ADDRESS, DESTINATION_IS_INTERNAL, CHAIN_NOT_ENABLED, FAUCET_ONLY_SANDBOX, FAUCET_ADDRESS_NOT_FOUND, FAUCET_INVALID_ASSET, FAUCET_AMOUNT_OVER_CAP, FAUCET_RATE_LIMITED, FAUCET_TOO_MANY_ITEMS, FAUCET_DUPLICATE_ASSET, FAUCET_NATIVE_REQUIRES_DEPOSIT, FAUCET_NATIVE_BUDGET_EXCEEDED, FAUCET_DISPENSER_EXHAUSTED, WITHDRAWAL_NOT_CANCELLABLE, IDEMPOTENCY_CONFLICT, IDEMPOTENCY_MISMATCH, IDEMPOTENCY_KEY_INVALID, FEATURE_NOT_AVAILABLE, RATE_LIMITED, DATABASE_ERROR, INTERNAL_ERROR, UNAUTHORIZED, FORBIDDEN, UNSUPPORTED_MEDIA_TYPE, WITHDRAWALS_FROZEN, WORKSPACE_NOT_FOUND, SYSTEM_WORKSPACE_PROTECTED, FAUCET_INVALID_AMOUNT, FAUCET_NO_ASSETS, FAUCET_NOT_SANDBOX. Most failures do NOT carry a business code. 326 throw sites raise a generic one (VALIDATION_ERROR, NOT_FOUND, UNPROCESSABLE, UNAUTHORIZED, CONFLICT, FORBIDDEN) against 46 named public codes, so a generic code is the common case and a named one is the exception. Branch on code; treat error as human text that may be reworded. The full catalogue, with causes and next steps, is the Error codes guide.

string

Example

{
  "error": "Insufficient balance. Available: 10.000000, Requested: 50.000000",
  "code": "INSUFFICIENT_BALANCE"
}