get listing
GET /api/rest/admin/payments
Parameters
| Name |
Description |
|
filter[id]
|
id filter
|
|
filter[account.id]
|
account.id filter
|
|
filter[id-eq]
|
id eq filter
|
|
filter[id-not-eq]
|
id not eq filter
|
|
filter[id-gt]
|
id gt filter
|
|
filter[id-gteq]
|
id gteq filter
|
|
filter[id-lt]
|
id lt filter
|
|
filter[id-lteq]
|
id lteq filter
|
|
filter[id-in]
|
id in filter
|
|
filter[id-not-in]
|
id not in filter
|
|
filter[created-at-eq]
|
created at eq filter
|
|
filter[created-at-not-eq]
|
created at not eq filter
|
|
filter[created-at-gt]
|
created at gt filter
|
|
filter[created-at-gteq]
|
created at gteq filter
|
|
filter[created-at-lt]
|
created at lt filter
|
|
filter[created-at-lteq]
|
created at lteq filter
|
|
filter[created-at-in]
|
created at in filter
|
|
filter[created-at-not-in]
|
created at not in filter
|
|
filter[rolledback-at-eq]
|
rolledback at eq filter
|
|
filter[rolledback-at-not-eq]
|
rolledback at not eq filter
|
|
filter[rolledback-at-gt]
|
rolledback at gt filter
|
|
filter[rolledback-at-gteq]
|
rolledback at gteq filter
|
|
filter[rolledback-at-lt]
|
rolledback at lt filter
|
|
filter[rolledback-at-lteq]
|
rolledback at lteq filter
|
|
filter[rolledback-at-in]
|
rolledback at in filter
|
|
filter[rolledback-at-not-in]
|
rolledback at not in filter
|
|
filter[amount-eq]
|
amount eq filter
|
|
filter[amount-not-eq]
|
amount not eq filter
|
|
filter[amount-gt]
|
amount gt filter
|
|
filter[amount-gteq]
|
amount gteq filter
|
|
filter[amount-lt]
|
amount lt filter
|
|
filter[amount-lteq]
|
amount lteq filter
|
|
filter[amount-in]
|
amount in filter
|
|
filter[amount-not-in]
|
amount not in filter
|
|
filter[notes-eq]
|
notes eq filter
|
|
filter[notes-not-eq]
|
notes not eq filter
|
|
filter[notes-cont]
|
notes cont filter
|
|
filter[notes-start]
|
notes start filter
|
|
filter[notes-end]
|
notes end filter
|
|
filter[notes-in]
|
notes in filter
|
|
filter[notes-not-in]
|
notes not in filter
|
|
filter[notes-cont-any]
|
notes cont any filter
|
|
filter[private-notes-eq]
|
private notes eq filter
|
|
filter[private-notes-not-eq]
|
private notes not eq filter
|
|
filter[private-notes-cont]
|
private notes cont filter
|
|
filter[private-notes-start]
|
private notes start filter
|
|
filter[private-notes-end]
|
private notes end filter
|
|
filter[private-notes-in]
|
private notes in filter
|
|
filter[private-notes-not-in]
|
private notes not in filter
|
|
filter[private-notes-cont-any]
|
private notes cont any filter
|
|
filter[status-eq]
|
status eq filter
|
|
filter[status-not-eq]
|
status not eq filter
|
|
filter[status-in]
|
status in filter
|
|
filter[status-not-in]
|
status not in filter
|
|
filter[type-name-eq]
|
type name eq filter
|
|
filter[type-name-not-eq]
|
type name not eq filter
|
|
filter[type-name-in]
|
type name in filter
|
|
filter[type-name-not-in]
|
type name not in filter
|
Request
Headers
Route
GET /api/rest/admin/payments
Response
Headers
Status
200 OK
Body
{
"data": [
{
"id": "31",
"type": "payments",
"links": {
"self": "http://example.org/api/rest/admin/payments/31"
},
"attributes": {
"created-at": "2026-01-02T12:46:09.512Z",
"amount": "10.0",
"notes": "notes text",
"private-notes": "private notes",
"status": "completed",
"type-name": "manual",
"balance-before-payment": "0.0",
"rolledback-at": null
},
"relationships": {
"account": {
"links": {
"self": "http://example.org/api/rest/admin/payments/31/relationships/account",
"related": "http://example.org/api/rest/admin/payments/31/account"
},
"data": {
"type": "accounts",
"id": "83"
}
}
}
},
{
"id": "32",
"type": "payments",
"links": {
"self": "http://example.org/api/rest/admin/payments/32"
},
"attributes": {
"created-at": "2026-01-02T12:46:09.540Z",
"amount": "10.0",
"notes": "notes text",
"private-notes": "private notes",
"status": "completed",
"type-name": "manual",
"balance-before-payment": "0.0",
"rolledback-at": null
},
"relationships": {
"account": {
"links": {
"self": "http://example.org/api/rest/admin/payments/32/relationships/account",
"related": "http://example.org/api/rest/admin/payments/32/account"
},
"data": {
"type": "accounts",
"id": "84"
}
}
}
}
],
"meta": {
"total-count": 2
},
"links": {
"first": "http://example.org/api/rest/admin/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "http://example.org/api/rest/admin/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}