v1

latestOpenAPI 3.0.1MIT2026-07-261190449.2 KB
Payments

Payment Details

Returns a single payment by its ID.

get/payments/{paymentId}

Path parameters

paymentIdstring uuid required

The unique identifier of the payment.

Response

Ok

paymentIdstring uuid

The unique identifier of the payment.

publicPaymentIdstring uuid

The public identifier of the payment.

organizationIdstring 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 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.

paymentDefermentInDaysinteger nullable

The number of days the payment is deferred.

cutoffDatestring 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.

plannedPaymentDatestring date nullable

The planned payment date of the payment, e.g 2023-03-23.

actualPaymentDatestring 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.

partnerSubmissionStatusSyncedAtstring date-time nullable

The date when the partnerSubmissionStatus was set to SYNCED.

partnerSubmissionStatusTempLockedAtstring date-time nullable

The date when the partnerSubmissionStatus was set to TEMP_LOCKED.

partnerSubmissionStatusLockedAtstring date-time nullable

The date when the partnerSubmissionStatus was set to LOCKED.

createdAtstring date-time

The date when the payment was created.

updatedAtstring date-time nullable

The date when the payment was last updated.

relatedTransactionsstring[]

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.

cardAccountIdstring uuid

The unique identifier of the card account.

billIdstring uuid nullable

The unique identifier of the bill associated with this payment.