---
title: "Query payout movements"
method: POST
path: "/v2/payouts/{payout_id}/movements/query"
tags: ["Payouts"]
---

# Query payout movements

`POST /v2/payouts/{payout_id}/movements/query`

## Request

- Base URL: `https://api.getpaid.io`
- URL: `https://api.getpaid.io/v2/payouts/{payout_id}/movements/query`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.getpaid.io/oauth/token` scopes: `payouts:read`
- TypeScript: <https://skmtc.dev/getpaid/apis/getpaid-api/docs/v2/payouts/:payout_id/movements/query/post.ts> (a function with typed inputs; its response is checked against the schema)

List the account movements assigned to a payout.

## Path parameters

- `payout_id` string, id, required: The unique identifier of the payout.

## Headers

- `Getpaid-Idempotency-Key` string, required

## Request body

- QueryPayoutMovementsRequest
  - `first` integer: Pagination. The number of elements that will be retrieved.
  - `after` string: Pagination. The `cursor` from next page will be retrieved.

## Response `200`

OK

- QueryPayoutMovementsResponse
  - `cursor` string: The cursor to the last item. If non-empty, can be used to fetch the next page. If not set, there is no more elements.
  - `data` object[], required: The list of queried elements.
    - `id` string, id, required: The unique identifier of an account movement.
    - `type` 'capture_split' | 'refund_split' | 'payout_fee' | 'authorization_declined' | 'authentication_failed', required: The event that generated the movement.
    - `gross_amount` integer, required: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
    - `processing_fees` integer, required: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
    - `net_amount` integer, required: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
    - `currency` string, currency, required: The processing currency code according to the [ISO-4217 standard](https://en.wikipedia.org/wiki/ISO_4217)
    - `created_at` string, date-time, required: UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)). Always includes the 'Z' UTC indicator.
    - `operation` PayoutMovementOperation, required: The immediate financial operation that generated the movement.
      - `type` 'capture' | 'refund' | 'authorization' | '3ds_authentication' | 'payout', required: The type of operation.
      - `id` string, id
      - `reference` string, required: An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.
      - `gross_amount` integer, required: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
    - `payment` PayoutMovementPayment: The payment associated with the movement.
      - `id` string, id, required: The unique identifier of the payment.
      - `reference` string, required: An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.
      - `gross_amount` integer, required: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
      - `origin` union, required
        - object
          - `type` string, required: The payment origin type. - `api`: The payment was created via the API. - `checkout`: The payment was created as an attempt of a checkout session.
        - object
          - `type` string, required: The payment origin type. - `api`: The payment was created via the API. - `checkout`: The payment was created as an attempt of a checkout session.
          - `id` string, id, required: The unique identifier of the checkout.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `422`: Invalid Parameters
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/getpaid/apis/getpaid-api.md) - [All operations](https://skmtc.dev/getpaid/apis/getpaid-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getpaid/apis/getpaid-api/revisions/458eae3d49ad?raw)