---
title: "List all payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List all payments

`GET /payments`

List all payments

## Query parameters

- `nextToken` string
- `pageSize` integer

## Response `200`

Response for GET payments requests

- ListPaymentResponse — List payments response
  - `data` Payment[], required
    - `id` string, required
    - `description` string
    - `notes` string
    - `accountId` string, required
    - `externalPaymentReferences` ExternalPaymentReference, required — external payment reference object
      - `sourceName` string, required
      - `sourceType` 'GATEWAY' | 'CASH' | 'CHEQUE' | 'BANK_TRANSFER' | 'CARD', required
      - `transactionNumber` string, required — Check number or Card transaction number
      - `description` string
      - `metadata` object
    - `lineItemRecords` PaymentLineItemRecord[], required
      - `type` 'INVOICE' | 'CREDIT' | 'WALLET_CREDIT', required
      - `togaiId` string
      - `amount` number
      - `order` integer, required
    - `totalAmount` number, required
    - `currency` string, required
    - `version` number, required
    - `createdBy` string, required
    - `createdAt` string, date-time, required
  - `nextToken` string

## Other responses

- `400` — Error response
- `401` — Error response
- `403` — Error response
- `404` — Error response
- `429` — Error response
- `default` — Error response

---

[API](https://skmtc.net/togaihq/apis/togai-apis.md) · [All operations](https://skmtc.net/togaihq/apis/togai-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/togaihq/togai-apis/revisions/442f5d8f4aa0/schema)