> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnosispay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List withdrawals

> Lists on-chain withdrawals available to the authenticated partner.

`account_id` is required and scopes the result to one account. Results are
returned newest first. Use the withdrawal-by-ID route to track a specific
withdrawal after creation.



## OpenAPI

````yaml https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/withdrawals
openapi: 3.1.0
info:
  title: Gnosis Pay Partner API
  version: 1.0.0
  description: >-
    Server-to-server API for onboarding users, creating accounts and cards,
    moving

    funds, and managing the card lifecycle. Call this API only from a trusted

    backend. Every request requires a partner access token, and every resource
    is

    scoped to the authenticated partner.
servers:
  - url: https://core.prod.gnosispay.com/partner-api
    description: Production
    variables: {}
  - url: https://core.sandbox.gnosispay.in/core
    description: Sandbox
    variables: {}
security:
  - BearerAuth: []
tags:
  - name: Accounts
  - name: Cards
  - name: Card transactions
  - name: KYC
  - name: Deposits
  - name: Withdrawals
  - name: PCI
  - name: 3DS
  - name: Webhooks
paths:
  /v1/withdrawals:
    get:
      tags:
        - Withdrawals
      summary: List withdrawals
      description: >-
        Lists on-chain withdrawals available to the authenticated partner.


        `account_id` is required and scopes the result to one account. Results
        are

        returned newest first. Use the withdrawal-by-ID route to track a
        specific

        withdrawal after creation.
      operationId: withdrawals.list.v1
      parameters:
        - name: account_id
          in: query
          required: true
          description: >-
            The account whose withdrawals to list. The items are sorted by
            `created_at`, newest first.
          schema:
            $ref: '#/components/schemas/uuid'
          explode: false
        - name: page_size
          in: query
          required: false
          description: The number of withdrawals on each page (1-100).
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 100
            default: 10
          explode: false
        - name: page_cursor
          in: query
          required: false
          description: >-
            The cursor of the page to return. Its value comes from
            `pagination.next_page_cursor` in the previous response.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OnchainWithdrawal'
                  pagination:
                    $ref: '#/components/schemas/PaginationInfo'
                description: Paginated response containing data and pagination metadata
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    uuid:
      type: string
      format: uuid
    OnchainWithdrawal:
      type: object
      required:
        - id
        - account_id
        - chain_id
        - safe_address
        - token
        - token_name
        - amount
        - to_address
        - tx_hash
        - block_number
        - status
        - api_initiated
        - created_at
        - updated_at
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique withdrawal identifier.
        account_id:
          $ref: '#/components/schemas/uuid'
          description: Account sending the withdrawal.
        chain_id:
          type: integer
          format: int32
          description: Numeric blockchain network ID.
        safe_address:
          type: string
          description: Account funding address that sent the tokens.
        token:
          type: string
          description: Token contract address.
        token_name:
          type: string
          description: Human-readable token name.
        amount:
          type: string
          description: Amount in the token's smallest unit.
        to_address:
          type: string
          description: Destination address.
        tx_hash:
          type: string
          description: >-
            Blockchain transaction hash; empty until the transaction is
            submitted.
        block_number:
          type: integer
          format: int64
          description: Block number containing the transaction; zero until it is confirmed.
        status:
          $ref: '#/components/schemas/OnchainWithdrawalStatus'
          description: Current withdrawal status.
        api_initiated:
          type: boolean
          description: Whether the withdrawal was requested through an API.
        created_at:
          type: string
          format: date-time
          description: When the withdrawal was first recorded.
        updated_at:
          type: string
          format: date-time
          description: When the withdrawal was last updated.
    PaginationInfo:
      type: object
      required:
        - next_page_cursor
        - has_next
      properties:
        next_page_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Base64-encoded cursor for the next page, null if no more items
        has_next:
          type: boolean
          description: True if there are more items available
      description: Pagination metadata for cursor-based pagination
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code.
        message:
          type: string
          description: Generic human-readable text for the status code. Do not parse it.
        reason:
          type: string
          description: >-
            Stable machine-readable code identifying the specific cause, present
            only

            for errors that expose one (e.g. `CREATE_CARD_LIMIT_EXCEEDED`).
            Branch on

            this rather than on `message`.
    OnchainWithdrawalStatus:
      type: string
      enum:
        - pending
        - completed
        - failed
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.