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

# List of Payments

`GET /payments`

Returns a list of payments with metadata. Payments happen according to the payment frequency of the organization. They include and consider all relevant transactions and other payments during the specified period. You can use the `limit`, `page`, `sortBy` and `sortDirection` parameters to filter and sort the results.

## Query parameters

- `organizationId` string, uuid, required
- `cardAccountId` string, uuid
- `type` 'BILL' | 'TOPUP' | 'DIRECT_DEBIT_REVERSAL' | 'PAYOUT'
- `status` 'PLANNED' | 'UPCOMING' | 'DEFERRED' | 'READY_FOR_PMT' | 'PENDING' | 'PAID' | 'FAILED' | 'DISCARDED' | 'BOOKED' | 'REVERSED'
- `fromDate` string, date-time, nullable
- `toDate` string, date-time, nullable
- `byDateField` 'cutoffDate' | 'collectionDate' | 'paymentDate' | 'updatedAt' | 'createdAt', nullable
- `limit` integer
- `page` integer
- `sortBy` 'organizationId' | 'status' | 'type' | 'cutoffDate' | 'collectionDate' | 'paymentDate' | 'createdAt'
- `sortDirection` 'ASC' | 'DESC'

## Response `200`

Ok

- object
  - `data` object[]
    - `paymentId` string, uuid — The unique identifier of the payment.
    - `organizationId` string, uuid — The unique identifier of the organization.
    - `cardAccountId` string, uuid — The unique identifier of the [card account](/docs/card-account).
    - `publicPaymentId` string, nullable — The public payment reference used for reconciliation. This value can be `null` at payout creation and is populated after payment file generation. Use payout callbacks to receive the populated value.
    - `type` 'BILL' | 'TOPUP' | 'DIRECT_DEBIT_REVERSAL' | 'BILL_PAYMENT_REVERSAL' | 'PAYOUT' | 'OTHER' — * `BILL` - Bill that is being deducted from the account after transactions have been processed * `TOPUP` - Top-up that is being transferred onto the account before transactions are initiated * `DIRECT_DEBIT_REVERSAL` - Organization is charged with a fee because direct debit was not successful multiple times * `BILL_PAYMENT_REVERSAL` - Organization is charged with a fee because bill payment was not successful multiple times * `PAYOUT` - Money transferred from Pliant to an external bank account (only for pre-funded organizations) out of Pliant * `OTHER`
    - `method` 'DIRECT_DEBIT_CORE' | 'DIRECT_DEBIT_B2B' | 'WIRE_TRANSFER' — * `DIRECT_DEBIT` - prefix indicates that money was send to Pliant platform via direct debit * `WIRE_TRANSFER` - prefix indicates that money has been sent to Pliant platform via wire transfer (SEPA credit transfer)
    - `amount` object — The amount of the payment.
      - `value` number — The value of the monetary amount, converted to minor units of the currency. For instance 1.00 EUR is 100 cents, thus the value here is `100`. See our [guides](/docs/monetary-values) for more details about how to handle monetary amounts.
      - `currency` string — The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar.
    - `status` 'PLANNED' | 'UPCOMING' | 'DEFERRED' | 'READY_FOR_PMT' | 'PENDING' | 'PAID' | 'FAILED' | 'DISCARDED' | 'BOOKED' | 'REVERSED' — The status of the payment.
  - `hasNextPage` boolean — Indicates whether there is a next page available.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — unresolved $ref
- `429` — unresolved $ref
- `500` — unresolved $ref

---

[API](https://skmtc.dev/getpliant/apis/pliant-customer-api.md) · [All operations](https://skmtc.dev/getpliant/apis/pliant-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getpliant/pliant-customer-api/revisions/f3f589cfa718/schema)