# List all withdrawals

Endpoint: GET /withdrawals
Version: 1.0.0
Security: JWT

## Query parameters:

  - `withdrawal_account_id` (string)
    The unique identifier of the beneficiary
    Example: "accwith_162843c10333"

  - `status` (string)
    Status of withdrawal to filter
    Enum: "in_progress", "success", "failed", "action_required", "cancelled", "under_review"

  - `before` (string)
    ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid Page drift issue. See Pagination parameters for more details.
    Example: "2025-02-18T12:03:44Z"

  - `after` (string)
    ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid Page drift issue. See Pagination parameters for more details.
    Example: "2025-01-18T12:03:44Z"

  - `per_page` (integer)
    Number of resources per page. Should be between 1 and 100.

  - `page` (integer)
    Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string)
    The unique identifier for the withdrawal.
    Example: "payout_DdWpHUbOnlg"

  - `data.status` (string)
    The status of the withdrawal.
    Enum: "in_progress", "success", "failed", "action_required", "cancelled", "under_review"

  - `data.currency` (string)
    The currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, USD.
    Example: "USD"

  - `data.amount` (number)
    The amount you want to receive in cents. For example, 1000 cents is $10.00.  The currency is determined by the currency field. Cents is a general  term for the smallest unit of currency in any currency. It does not  necessarily mean USD cents.
    Example: 1000

  - `data.withdrawal_account_id` (string)
    The unique identifier for the withdrawal account.
    Example: "accwith_5JU9yv0lGSUP"

  - `data.payment_method` (string)
    The payment method to use for the withdrawal.
    Enum: "bank_transfer"

  - `data.balance_used` (array)
    The amount in cents that was deducted from your balance for this withdrawal.

  - `data.balance_used.amount` (number)
    The balance amount in the smallest currency unit. For example, if the amount is $299.00, then 29900 is passed in  this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.
    Example: 1000

  - `data.purpose_code` (string)
    Purpose code for why you want to receive this payment
    Example: "S0017"

  - `data.mid_market_rate` (array)
    The mid-market rate at the time of withdrawal creation.

  - `data.mid_market_rate.rate` (number)
    The the conversion rate used for the currency(ies) for a given transaction.
    Example: 1.4

  - `data.fx_fees` (array)
    The FX fees applied to the withdrawal.

  - `data.txn_fees` (array)
    The transaction fees applied to the withdrawal.

  - `data.created_at` (string)
    Timestamp representing when the payin was created
    Example: "2021-06-01T12:00:00Z"

  - `data.updated_at` (string)
    Timestamp representing when the payin was last updated
    Example: "2021-06-01T12:00:00Z"

  - `page_meta` (object)

  - `page_meta.current` (integer)
    The current page number.
    Example: 2

  - `page_meta.previous` (integer,null)
    The previous page number.
    Example: 1

  - `page_meta.next` (integer,null)
    The next page number.
    Example: 3

  - `page_meta.per_page` (integer)
    The number of items per page.
    Example: 20

  - `page_meta.pages` (integer)
    The total number of pages.
    Example: 10

  - `page_meta.count` (integer)
    The total number of items.
    Example: 200