> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List withdrawals > Returns a paginated list of withdrawals for a company, with optional sorting and date filtering. Required permissions: - `payout:withdrawal:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /withdrawals openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: 2026-07-08-1 servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /withdrawals: get: tags: - Withdrawals summary: List withdrawals description: >- Returns a paginated list of withdrawals for a company, with optional sorting and date filtering. Required permissions: - `payout:withdrawal:read` operationId: listWithdrawal parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: - string - 'null' style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: - string - 'null' style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: - integer - 'null' style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: - integer - 'null' style: form - explode: true in: query name: company_id required: true schema: description: The unique identifier of the company to list withdrawals for. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: direction required: false schema: description: The sort direction for results. Defaults to descending. oneOf: - $ref: '#/components/schemas/Direction' - type: 'null' style: form - explode: true in: query name: created_before required: false schema: description: Only return withdrawals created before this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' style: form - explode: true in: query name: created_after required: false schema: description: Only return withdrawals created after this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' style: form responses: '200': content: application/json: schema: description: The connection type for PublicWithdrawal. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/WithdrawalListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - payout:withdrawal:read components: schemas: Direction: description: The direction of the sort. enum: - asc - desc type: string WithdrawalListItem: description: >- A withdrawal represents a request to transfer funds from a ledger account to an external payout method. properties: amount: description: >- The withdrawal amount as a decimal number in the specified currency (e.g., 100.00 for $100.00 USD). example: 6.9 type: number created_at: description: The datetime the withdrawal was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string currency: $ref: '#/components/schemas/Currencies' description: >- The three-letter ISO currency code for this withdrawal (e.g., 'usd', 'eur'). fee_amount: description: >- The fee charged for processing this withdrawal, in the same currency as the withdrawal amount. example: 6.9 type: number fee_type: description: >- How the fee was applied to the withdrawal. 'exclusive' means the fee was added on top (user receives the full requested amount). 'inclusive' means the fee was deducted from the withdrawal (user receives less than requested). Null if no fee was charged. oneOf: - $ref: '#/components/schemas/WithdrawalFeeTypes' - type: 'null' id: description: The unique identifier for the withdrawal. example: wdrl_xxxxxxxxxxxxx type: string markup_fee: description: >- An additional markup fee charged for the withdrawal, in the same currency as the withdrawal amount. Only applies to platform accounts using Whop Rails. example: 6.9 type: number speed: $ref: '#/components/schemas/WithdrawalSpeeds' description: >- The processing speed selected for this withdrawal ('standard' or 'instant'). status: $ref: '#/components/schemas/WithdrawalStatus' description: >- The computed lifecycle status of the withdrawal, accounting for the state of associated payouts (e.g., 'requested', 'in_transit', 'completed', 'failed'). required: - id - status - amount - currency - fee_amount - fee_type - speed - created_at - markup_fee type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object Currencies: description: The available currencies on the platform enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau type: string WithdrawalFeeTypes: description: The different fee types for a withdrawal. enum: - exclusive - inclusive type: string WithdrawalSpeeds: description: The different speeds of withdrawals enum: - standard - instant type: string WithdrawalStatus: description: The status of a withdrawal request enum: - requested - awaiting_payment - in_transit - completed - failed - canceled - denied type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer type: http ````