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.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo1MSwiZXhwIjoxNzg4NjA1OTg1fQ.Hvvuldx_Lr_1aHFfczBSHeQTDSgGkWlJU0pAobyG74w
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/payments/c3ca2718-a918-11f1-96b6-d211d3fe052e

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/"7cae363b8cffdfc499a555644280c218"
cache-control: max-age=0, private, must-revalidate
x-request-id: 6d9403ba-8052-406e-b78c-0f3de9e9e282
x-runtime: 0.014667
content-length: 643

Status

200 OK

Body

{
  "data": {
    "id": "c3ca2718-a918-11f1-96b6-d211d3fe052e",
    "type": "payments",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/payments/c3ca2718-a918-11f1-96b6-d211d3fe052e"
    },
    "attributes": {
      "amount": "10.0",
      "currency": "USD",
      "notes": "notes text",
      "status": "completed",
      "type-name": "manual",
      "created-at": "2026-09-05T10:58:45.430Z",
      "balance-before-payment": "0.0",
      "rolledback-at": null
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/customer/v1/payments/c3ca2718-a918-11f1-96b6-d211d3fe052e/relationships/account",
          "related": "http://example.org/api/rest/customer/v1/payments/c3ca2718-a918-11f1-96b6-d211d3fe052e/account"
        }
      }
    }
  }
}