---
title: "GET /billing/{tenantLocator}/payments/list"
method: GET
path: "/billing/{tenantLocator}/payments/list"
---

# GET /billing/{tenantLocator}/payments/list

`GET /billing/{tenantLocator}/payments/list`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/{tenantLocator}/payments/list`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/payments/list/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `offset` integer
- `count` integer
- `accountLocator` string, ulid
- `targetContainerLocator` string, ulid

## Response `200`

OK

- ListPageResponsePaymentResponse
  - `listCompleted` boolean, required
  - `items` PaymentResponse[], required
    - `locator` string, ulid, required
    - `paymentState` 'draft' | 'validated' | 'requested' | 'executing' | 'posting' | 'posted' | 'failed' | 'cancelled' | 'reversing' | 'reversed' | 'discarded', required
    - `type` string, required
    - `currency` string, required
    - `amount` number, required
    - `remainingAmount` number
    - `data` object
    - `createdAt` string, date-time, required
    - `createdBy` string, uuid, required
    - `accountLocator` string, ulid
    - `targets` CreditItem[], required
      - `containerLocator` string, ulid, required
      - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
      - `amount` number
    - `externalCashTransactionLocator` string, ulid
    - `validationResult` ValidationResult
      - `validationItems` ValidationItemResponse[]
        - `elementType` string, required
        - `locator` string, ulid, required
        - `errors` string[], required
      - `success` boolean, required
    - `postedAt` string, date-time
    - `reversalReason` string
    - `reversedAt` string, date-time
    - `reversedBy` string, uuid
    - `shortfallCreditLocators` string[], required
    - `subpayments` SubpaymentResponse[], required
      - `subpaymentLocator` string, ulid, required
      - `amount` number, required
    - `paymentMode` 'normal' | 'aggregate'
    - `aggregatePaymentLocator` string, ulid
    - `paymentNumber` string
    - `anonymizedAt` string, date-time
    - `executionLog` PaymentRequestExecutionLogItem[], required
      - `paymentRequestLocator` string, ulid, required
      - `paymentRequestState` 'pending' | 'completed' | 'failed' | 'error', required
      - `requestTime` string, date-time
      - `transactionId` string
      - `note` string
      - `data` object, required
    - `nextRequestTime` string, date-time
    - `retryPlanName` string

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)