v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Payments

List all payments

get/payments

Query parameters

nextTokenstring

Example:eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==

Pagination token used as a marker to get records from next page.

pageSizeinteger

Example:10

Maximum page size expected by client to return the record list.

NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Response

Response for GET payments requests

nextTokenstring

Example response

{
  "data": [
    {
      "id": "pay.w123rwe.1231",
      "accountId": "ACC001",
      "lineItemRecords": [
        {
          "togaiId": "inv.234.12efwe"
        }
      ]
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
}