Payments API

create new entry

POST /api/rest/admin/payments

Parameters

Name	Description
data[type]	Resource type (payments)
data[attributes][amount]	Amount
data[attributes][notes]	Notes
data[relationships][account]	Account

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE3OSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc4NjM2MDI5NX0.sknGlWbLvcgLaPALD-7ExyjiOVcon3zq1KvMWL3tuLY
Host: example.org
Cookie: 

Route

POST /api/rest/admin/payments

Body

{"data":{"type":"payments","attributes":{"amount":10},"relationships":{"account":{"data":{"type":"accounts","id":88}}}}}

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
location: http://example.org/api/rest/admin/payments/34
vary: Accept
etag: W/"57ccd8fd05386e50092ce18748297488"
cache-control: max-age=0, private, must-revalidate
x-request-id: 335b74ef-d963-440a-826a-869bf3c377a9
x-runtime: 0.018136
content-length: 539

Status

201 Created

Body

{
  "data": {
    "id": "34",
    "type": "payments",
    "links": {
      "self": "http://example.org/api/rest/admin/payments/34"
    },
    "attributes": {
      "created-at": "2026-08-10T11:01:35.858Z",
      "amount": "10.0",
      "currency": "USD",
      "notes": null,
      "private-notes": null,
      "status": "completed",
      "type-name": "manual",
      "balance-before-payment": "0.0",
      "rolledback-at": null
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/admin/payments/34/relationships/account",
          "related": "http://example.org/api/rest/admin/payments/34/account"
        },
        "data": {
          "type": "accounts",
          "id": "88"
        }
      }
    }
  }
}