Payments API

get listing

GET /api/rest/customer/v1/payments

Parameters

Name	Description
filter[id]	id filter
filter[uuid-eq]	uuid eq filter
filter[uuid-not-eq]	uuid not eq filter
filter[uuid-in]	uuid in filter
filter[uuid-not-in]	uuid not in filter
filter[notes-eq]	notes eq filter
filter[notes-not-eq]	notes not eq filter
filter[notes-cont]	notes cont filter
filter[notes-start]	notes start filter
filter[notes-end]	notes end filter
filter[notes-in]	notes in filter
filter[notes-not-in]	notes not in filter
filter[notes-cont-any]	notes cont any filter
filter[amount-eq]	amount eq filter
filter[amount-not-eq]	amount not eq filter
filter[amount-gt]	amount gt filter
filter[amount-gteq]	amount gteq filter
filter[amount-lt]	amount lt filter
filter[amount-lteq]	amount lteq filter
filter[amount-in]	amount in filter
filter[amount-not-in]	amount not in filter
filter[created-at-eq]	created at eq filter
filter[created-at-not-eq]	created at not eq filter
filter[created-at-gt]	created at gt filter
filter[created-at-gteq]	created at gteq filter
filter[created-at-lt]	created at lt filter
filter[created-at-lteq]	created at lteq filter
filter[created-at-in]	created at in filter
filter[created-at-not-in]	created at not in filter
filter[rolledback-at-eq]	rolledback at eq filter
filter[rolledback-at-not-eq]	rolledback at not eq filter
filter[rolledback-at-gt]	rolledback at gt filter
filter[rolledback-at-gteq]	rolledback at gteq filter
filter[rolledback-at-lt]	rolledback at lt filter
filter[rolledback-at-lteq]	rolledback at lteq filter
filter[rolledback-at-in]	rolledback at in filter
filter[rolledback-at-not-in]	rolledback at not in filter
filter[account-id-eq]	account id eq filter
filter[account-id-not-eq]	account id not eq filter
filter[account-id-in]	account id in filter
filter[account-id-not-in]	account id not in filter
filter[status-eq]	status eq filter
filter[status-not-eq]	status not eq filter
filter[status-in]	status in filter
filter[status-not-in]	status not in filter
filter[type-name-eq]	type name eq filter
filter[type-name-not-eq]	type name not eq filter
filter[type-name-in]	type name in filter
filter[type-name-not-in]	type name not in filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo0OSwiZXhwIjoxNzY3MzU4MDM2fQ.RRfHTkwHrkZtHwB-LtIy7YpJ199M_7pTpK_HMYEYoGY
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/payments

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"6f27cb04502af0c4de826a3241f34344"
cache-control: max-age=0, private, must-revalidate
x-request-id: f2124d3c-9963-489b-8a02-cda52c99cfa2
x-runtime: 0.010658
content-length: 1473

Status

200 OK

Body

{
  "data": [
    {
      "id": "076266ae-e7d9-11f0-932e-0a63caf27539",
      "type": "payments",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/payments/076266ae-e7d9-11f0-932e-0a63caf27539"
      },
      "attributes": {
        "amount": "10.0",
        "notes": "notes text",
        "status": "completed",
        "type-name": "manual",
        "created-at": "2026-01-02T12:46:16.628Z",
        "balance-before-payment": "10.0",
        "rolledback-at": null
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/payments/076266ae-e7d9-11f0-932e-0a63caf27539/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/payments/076266ae-e7d9-11f0-932e-0a63caf27539/account"
          }
        }
      }
    },
    {
      "id": "0760b570-e7d9-11f0-932e-0a63caf27539",
      "type": "payments",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/payments/0760b570-e7d9-11f0-932e-0a63caf27539"
      },
      "attributes": {
        "amount": "10.0",
        "notes": "notes text",
        "status": "completed",
        "type-name": "manual",
        "created-at": "2026-01-02T12:46:16.617Z",
        "balance-before-payment": "0.0",
        "rolledback-at": null
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/payments/0760b570-e7d9-11f0-932e-0a63caf27539/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/payments/0760b570-e7d9-11f0-932e-0a63caf27539/account"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}