Payments API

get listing

GET /api/rest/customer/v1/payments

Parameters

Name	Description
filter[id]	id filter
filter[uuid-eq]	uuid eq filter
filter[uuid-not-eq]	uuid not eq filter
filter[uuid-in]	uuid in filter
filter[uuid-not-in]	uuid 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[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[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[account-id-eq]	account id eq filter
filter[account-id-not-eq]	account id not eq filter
filter[account-id-in]	account id in filter
filter[account-id-not-in]	account id not in 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

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjMyLCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzEwMjU0MjAzfQ.z05eg26vCuU-ZNC-g2Nj9YAT6yHST8YjxY3IUAQyDJc
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/payments

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"ca4a5e6805937f6ad717a7e3d99842a4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 05ac2d5b-1f3b-45d4-b281-a3049a708c74
X-Runtime: 0.010325
Content-Length: 1368

Status

200 OK

Body

{
  "data": [
    {
      "id": "ce4dcfc0-e07d-11ee-bf85-0242ac120003",
      "type": "payments",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/payments/ce4dcfc0-e07d-11ee-bf85-0242ac120003"
      },
      "attributes": {
        "amount": "10.0",
        "notes": "notes text",
        "status": "completed",
        "type-name": "manual",
        "created-at": "2024-03-12T14:35:43.179Z"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/payments/ce4dcfc0-e07d-11ee-bf85-0242ac120003/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/payments/ce4dcfc0-e07d-11ee-bf85-0242ac120003/account"
          }
        }
      }
    },
    {
      "id": "ce5097aa-e07d-11ee-bf85-0242ac120003",
      "type": "payments",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/payments/ce5097aa-e07d-11ee-bf85-0242ac120003"
      },
      "attributes": {
        "amount": "10.0",
        "notes": "notes text",
        "status": "completed",
        "type-name": "manual",
        "created-at": "2024-03-12T14:35:43.198Z"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/payments/ce5097aa-e07d-11ee-bf85-0242ac120003/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/payments/ce5097aa-e07d-11ee-bf85-0242ac120003/account"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/payments?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}