Payouts

Query payout movements

List the account movements assigned to a payout.

post/v2/payouts/{payout_id}/movements/query

Request

Path parameters

payout_idstring id required

The unique identifier of the payout.

Headers

Getpaid-Idempotency-Keystring required
Example:5c255194-30ec-11ed-a261-0242ac120002

A unique idempotency key to allow safe retrying. See Getpaid API idempotency for more details.

Request body

firstinteger

Pagination. The number of elements that will be retrieved.

afterstring

Pagination. The cursor from next page will be retrieved.

Response

OK

cursorstring

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.

Example response

{
  "cursor": "Q3VyaW9zaXR5IEtpbGxlZCB0aGUgQ2F0Cg==",
  "data": [
    {
      "gross_amount": 1000,
      "processing_fees": 1000,
      "net_amount": 1000,
      "currency": "EUR",
      "created_at": "2025-09-01T22:05:48.479Z",
      "operation": {
        "reference": "ORD-202510-0232",
        "gross_amount": 1000
      },
      "payment": {
        "id": "pay_4a4m2pjycdb1jbj68h1rvk9kcz",
        "reference": "ORD-202510-0232",
        "gross_amount": 1000,
        "origin": {
          "id": "cko_4kf9v6xp00hzc99rdwr5m97wce"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.