Payments API

get specific entry

GET /api/rest/admin/payments/:id

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE3MiwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAwOH0.E-CF3MozPCNS7xiXCbOxf9oQUnMTlsqBj3UfKxALfYQ
Host: example.org
Cookie: 

Route

GET /api/rest/admin/payments/33

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/"732415854026d8c971eee2cf3c2ff5af"
cache-control: max-age=0, private, must-revalidate
x-request-id: c7ceed8e-032a-4e17-bd88-f659ba1fddc4
x-runtime: 0.006006
content-length: 541

Status

200 OK

Body

{
  "data": {
    "id": "33",
    "type": "payments",
    "links": {
      "self": "http://example.org/api/rest/admin/payments/33"
    },
    "attributes": {
      "created-at": "2026-02-27T16:56:48.604Z",
      "amount": "10.0",
      "notes": "notes text",
      "private-notes": "private notes",
      "status": "completed",
      "type-name": "manual",
      "balance-before-payment": "0.0",
      "rolledback-at": null
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/payments/33/relationships/account",
          "related": "http://example.org/api/rest/admin/payments/33/account"
        },
        "data": {
          "type": "accounts",
          "id": "87"
        }
      }
    }
  }
}