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.eyJzdWIiOjE3MSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2OX0.NeWhLQq-uNk25Y0_jgowdo_WicF9JThY0-ePe9hzXXg
Host: example.org
Cookie: 

Route

POST /api/rest/admin/payments

Body

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

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/"3b0a8a7f8b8bee6b976e89dc9605d5d8"
cache-control: max-age=0, private, must-revalidate
x-request-id: 0b11ba3a-543a-48df-bae0-219a89986190
x-runtime: 0.020557
content-length: 522

Status

201 Created

Body

{
  "data": {
    "id": "34",
    "type": "payments",
    "links": {
      "self": "http://example.org/api/rest/admin/payments/34"
    },
    "attributes": {
      "created-at": "2026-01-02T12:46:09.682Z",
      "amount": "10.0",
      "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": "86"
        }
      }
    }
  }
}