Payments API

get listing

GET /api/rest/admin/payments

Parameters

Name Description
filter[id] id filter
filter[account.id] account.id filter
filter[id-eq] id eq filter
filter[id-not-eq] id not eq filter
filter[id-gt] id gt filter
filter[id-gteq] id gteq filter
filter[id-lt] id lt filter
filter[id-lteq] id lteq filter
filter[id-in] id in filter
filter[id-not-in] id 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[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[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[private-notes-eq] private notes eq filter
filter[private-notes-not-eq] private notes not eq filter
filter[private-notes-cont] private notes cont filter
filter[private-notes-start] private notes start filter
filter[private-notes-end] private notes end filter
filter[private-notes-in] private notes in filter
filter[private-notes-not-in] private notes not in filter
filter[private-notes-cont-any] private notes cont any 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

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE2MywiYXVkIjpbImFkbWluIl0sImV4cCI6MTc0MDg1MzAzOH0.MaFoxS8ZY_w19rOEKlwgO-eg88KaEVxNDjVi0jt5bq4
Host: example.org
Cookie: 

Route

GET /api/rest/admin/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/"9c964c56d6bde0ee9bada7ad25bdc8a2"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3b8b8124-f0ff-40eb-bef6-7fc1bb09d0b0
X-Runtime: 0.009290
Content-Length: 1186

Status

200 OK

Body

{
  "data": [
    {
      "id": "31",
      "type": "payments",
      "links": {
        "self": "http://example.org/api/rest/admin/payments/31"
      },
      "attributes": {
        "created-at": "2025-03-01T18:07:18.072Z",
        "amount": "10.0",
        "notes": "notes text",
        "private-notes": "private notes",
        "status": "completed",
        "type-name": "manual"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/admin/payments/31/relationships/account",
            "related": "http://example.org/api/rest/admin/payments/31/account"
          },
          "data": {
            "type": "accounts",
            "id": "75"
          }
        }
      }
    },
    {
      "id": "32",
      "type": "payments",
      "links": {
        "self": "http://example.org/api/rest/admin/payments/32"
      },
      "attributes": {
        "created-at": "2025-03-01T18:07:18.123Z",
        "amount": "10.0",
        "notes": "notes text",
        "private-notes": "private notes",
        "status": "completed",
        "type-name": "manual"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/admin/payments/32/relationships/account",
            "related": "http://example.org/api/rest/admin/payments/32/account"
          },
          "data": {
            "type": "accounts",
            "id": "76"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}