Payments API

get specific entry

GET /api/rest/customer/v1/payments/:id

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo1MSwiZXhwIjoxNzg0MzgwODU3fQ.pAFGYAKg9GND4ahC9WnphBZ14yhrYTKGrBRwoMUiIP8
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/payments/5f56b3ca-82ab-11f1-8bff-7a20efe65af3

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/"8456d56bb024f473e2e6662de3a85222"
cache-control: max-age=0, private, must-revalidate
x-request-id: 9f04cc81-3908-4933-846e-a5411409729e
x-runtime: 0.010268
content-length: 643

Status

200 OK

Body

{
  "data": {
    "id": "5f56b3ca-82ab-11f1-8bff-7a20efe65af3",
    "type": "payments",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/payments/5f56b3ca-82ab-11f1-8bff-7a20efe65af3"
    },
    "attributes": {
      "amount": "10.0",
      "currency": "USD",
      "notes": "notes text",
      "status": "completed",
      "type-name": "manual",
      "created-at": "2026-07-18T13:19:57.572Z",
      "balance-before-payment": "0.0",
      "rolledback-at": null
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/customer/v1/payments/5f56b3ca-82ab-11f1-8bff-7a20efe65af3/relationships/account",
          "related": "http://example.org/api/rest/customer/v1/payments/5f56b3ca-82ab-11f1-8bff-7a20efe65af3/account"
        }
      }
    }
  }
}