TOtogaihq
Payments

List all payments

Changed on

List all payments

get/payments

Request

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=="
}

Changes

  • f22fc08442b7Revision changes
    • info

      the response property // became required for the status

  • ea9c4628bfdbRevision changes
    • warning

      added the new CHEQUE enum value to the /// response property for the response status

    • info

      removed the CHECK enum value from the /// response property for the response status