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

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE2NSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc0MDg1MzAzOH0.XTEuL65PGXKm8GU3KWqeIBP616xn9HF1UdL6labC1IM
Host: example.org
Cookie: 

Route

POST /api/rest/admin/payments

Body

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

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/"0f80af5e79c45b852a890e3ec35c901a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2c8ad611-e688-473b-a884-2f0556fa7b34
X-Runtime: 0.032626
Content-Length: 470

Status

201 Created

Body

{
  "data": {
    "id": "34",
    "type": "payments",
    "links": {
      "self": "http://example.org/api/rest/admin/payments/34"
    },
    "attributes": {
      "created-at": "2025-03-01T18:07:18.334Z",
      "amount": "10.0",
      "notes": null,
      "private-notes": null,
      "status": "completed",
      "type-name": "manual"
    },
    "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": "78"
        }
      }
    }
  }
}