---
title: "Payment Details"
method: GET
path: "/payments/{paymentId}"
tags: ["Payments"]
---

# Payment Details

`GET /payments/{paymentId}`

Returns a single payment by its ID.

## Path parameters

- `paymentId` string, uuid, required

## Response `200`

Ok

- object
  - `paymentId` string, uuid — The unique identifier of the payment.
  - `publicPaymentId` string, uuid — The public identifier of the payment.
  - `organizationId` string, uuid — The unique identifier of the organization.
  - `type` 'BILL' | 'TOPUP' | 'DIRECT_DEBIT_REVERSAL' | 'BILL_PAYMENT_REVERSAL' | 'PAYOUT' | 'INTERNAL_TRANSFER' | 'INTERNAL_TRANSFER_REVERSAL' | '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 `INTERNAL_TRANSFER` - Internal transfer payments are related to transferring funds between multiple card accounts of an organization, for example when the benefit card-account is loaded with money from the main card-account. `INTERNAL_TRANSFER_REVERSAL` - Internal transfer reversal payments are related to transferring funds between multiple card accounts of an organization. `OTHER`
  - `method` 'DIRECT_DEBIT_CORE' | 'DIRECT_DEBIT_B2B' | 'WIRE_TRANSFER' — `DIRECT_DEBIT_CORE`: Indicates that money was send to Pliant platform via core direct debit. `DIRECT_DEBIT_B2B`: Indicates that money was send to Pliant platform via B2B direct debit. `WIRE_TRANSFER`: Indicates that money has been sent to Pliant platform via wire transfer (SEPA credit transfer).
  - `status` 'PLANNED' | 'UPCOMING' | 'DEFERRED' | 'READY_FOR_PMT' | 'PENDING' | 'PAID' | 'FAILED' | 'DISCARDED' | 'BOOKED' | 'REVERSED' — The status of the payment. The initial payment status is `UPCOMING` for bills. It is different for other types of payments, see [our guides](/docs/payment-entity) for details. After midnight of the `cutoffDate` it changes to `READY_FOR_PMT`. This can be different under certain circumstances regarding the organizations payment terms, see `paymentDefermentInDays`. The day after the `cutoffDay`, around 15:00 German time, the payment is checked and submitted. The status then changes to `PENDING`. After midnight of the `plannedPaymentDate`, the payment status changes to `PAID`.
  - `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.
  - `paymentDefermentInDays` integer, nullable — The number of days the payment is deferred.
  - `cutoffDate` string, date, nullable — The cutoff date of the payment, e.g `2023-03-23`. This date describes the last day when transactions can be added to the payment. Or to put it differently: the cutoffDate is equal to or later than the last booked transaction linked to this payment. For payments of type `BILL` this field is normally filled. There is one special case where it might be empty for `BILL` payments: if a previous payment failed, we create a new payment of the same type and mark the failed payment as such. This newly created 'retry' payment will not have a `cutoffDate`, since it is just a retry of the already existing payment. Other payment types such as `TOPUP`, `BILL_PAYMENT_REVERSAL`, `DIRECT_DEBIT_REVERSAL` and `PAYOUT` will also not have a `cutoffDate`.
  - `plannedPaymentDate` string, date, nullable — The planned payment date of the payment, e.g `2023-03-23`.
  - `actualPaymentDate` string, date, nullable — The actual payment date of the payment, e.g `2023-03-23`.
  - `partnerSubmissionStatus` 'NOT_SYNCED' | 'SYNCED' | 'TEMP_LOCKED' | 'LOCKED' — The partner can use this field to indicate the processing of the payment on its side.
  - `partnerSubmissionStatusSyncedAt` string, date-time, nullable — The date when the partnerSubmissionStatus was set to SYNCED.
  - `partnerSubmissionStatusTempLockedAt` string, date-time, nullable — The date when the partnerSubmissionStatus was set to TEMP_LOCKED.
  - `partnerSubmissionStatusLockedAt` string, date-time, nullable — The date when the partnerSubmissionStatus was set to LOCKED.
  - `createdAt` string, date-time — The date when the payment was created.
  - `updatedAt` string, date-time, nullable — The date when the payment was last updated.
  - `relatedTransactions` string[] — The related transactions of this payment. This array will grow in size when a transaction is made within the payment frequency window of the organization. It will grow until (including) the `cutoffDate` of the payment. Transactions are added daily to payments at 09:00 German time.
  - `cardAccountId` string, uuid — The unique identifier of the [card account](/docs/card-account).
  - `billId` string, uuid, nullable — The unique identifier of the bill associated with this payment.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — unresolved $ref
- `404` — 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)