GEgetpaid
Payouts

Query payouts

List payouts across all accounts available to the caller, or restrict the result to one account.

A payout is always linked to one account. This endpoint intentionally supports querying across accounts so platforms can reconcile payouts for all of their sellers.

post/v2/payouts/query

Request

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

type'payouts' required

The type of the Getpaid solution resources to query.

Some query endpoints infer the resource type from the request path. In those cases, if this field is set, it must match the resource targeted by the request URL.

firstinteger

Pagination. The number of elements that will be retrieved.

afterstring

Pagination. The cursor from next page will be retrieved.

Example request

{
  "filters": {
    "account_id": "acc_44678r08jtm8zbt227tzhc4nw5",
    "reference": "ORD-202510-0232"
  }
}

Response

OK

type'payouts' required
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": [
    {
      "reference": "ORD-202510-0232",
      "account": {
        "id": "acc_44678r08jtm8zbt227tzhc4nw5"
      },
      "amount": 1000,
      "currency": "EUR",
      "created_at": "2025-09-01T22:05:48.479Z",
      "updated_at": "2025-09-01T22:05:48.479Z",
      "cutoff": {
        "from": "2025-09-01T22:05:48.479Z",
        "to": "2025-09-01T22:05:48.479Z"
      }
    }
  ]
}

Changes

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