GEgetpaid
Payments

Query payments

Query payments filtering, and sorting and paginating results.

See Query resources for more examples and details about other resources, pagination and everything related to operate the Getpaid solution.

post/v2/payments/query

Request

  • Base URL
    https://api.getpaid.io
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://auth.getpaid.io/oauth/token
      Scopespayments:read
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.getpaid.io/oauth/token
      Scopespayments:read_write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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'payments' 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": {
    "id": "pay_4a4m2pjycdb1jbj68h1rvk9kcz",
    "reference": "ORD-202510-0232"
  }
}

Response

OK

type'payments' 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": [
    {
      "id": "pay_4a4m2pjycdb1jbj68h1rvk9kcz",
      "reference": "ORD-202510-0232",
      "amount": 1000,
      "currency": "EUR",
      "created_at": "2025-09-01T22:05:48.479Z",
      "updated_at": "2025-09-01T22:05:48.479Z",
      "seller": {
        "id": "acc_44678r08jtm8zbt227tzhc4nw5"
      },
      "parties": [
        {
          "id": "acc_44678r08jtm8zbt227tzhc4nw5"
        }
      ]
    }
  ]
}

Changes

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