Skip to main content

List Withdrawals

The payouts of one member. member_id is required; further filters narrow by asset, network or client id.

GET/api/withdrawalsAuth: Required

Query Parameters​

member_idnumberRequired

Filter by member_id.

asset_idstring

Filter by asset_id.

dchain_idstring

Filter by dchain_id.

client_withdrawal_idstring

Look up one payout by the id you sent on creation. With this parameter the response is that single payout object, not a paginated envelope. member_id is still required, but the lookup covers all your members, and the other filters are ignored. If there is no such payout, the call answers 200 with an empty object {}.

pagenumber

Page number. Default 1.

per_pagenumber

Items per page. Default 20, maximum 1000.

Response​

A paginated envelope; withdrawals are in items.

itemsarrayRequired

Withdrawals.

More attributes