Payment
At Pliant, a payment occurs when money is sent to the platform either
- via bill payment (after transactions have been created with the cards),
- via top-up payment (before transactions can be created with the cards).
Thus the payment brings the credit card account back to zero or close to it (due to credit card transactions in between). Payments happen according to the payment frequency of the organization. They include and consider all relevant transactions and other payments during the specified period.
To select the next upcoming payment for an organization, please fetch all BILL
payments with the following statuses: PLANNED
, UPCOMING
, READY_FOR_PMT
, PENDING
and DEFERRED
and select the one with the closest plannedPaymentDate
.
Data Model
Field | Type | Description |
---|---|---|
paymentId | uuid | An identifier for the payment, unique to the company |
publicPaymentId | string | The "human-friendly" 8 digits identifier is used in Pliant Apps and is part of the reference on the bank statement of the customer |
organizationId | uuid | An identifier for the organization that the payment belongs to; unique on the platform |
billId (deprecated) | uuid | The billId of the statement, the payment belongs to |
type | string | Type of the payment.BILL - Bill that is being deducted from the account after transactions have been processedBILL_PAYMENT_REVERSAL - Occurs when a Bill payment fails after it is receivedDIRECT_DEBIT_REVERSAL - The cost of a Bill payment reversal. This always occurs with Bill payment reversalTOPUP - Top-up that is being transferred onto the account before transactions are initiatedPAYOUT - Withdrawing money from the Pliant account to other bank accountsOTHER - Non-classified payment types |
method | string | Method of payment; typically this is SEPA Direct Debit.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). |
amount | object | An array in regard to the amount for the given payment - value (decimal) - currency (string) |
status | string | Current state of the transaction, either: For BILL :- PLANNED (deprecated status, will only appear in older data)- UPCOMING - READY_FOR_PMT - DEFERRED - PENDING - PAID - DISCARDED For BILL_PAYMENT_REVERSAL andDIRECT_DEBIT_REVERSAL :- BOOKED Note: DIRECT_DEBIT_REVERSAL cannot occur without a BILL_PAYMENT_REVERSAL For TOPUP :- PAID For PAYOUT :- READY_FOR_PMT - PENDING - PAID For OTHER :- BOOKED |
paymentDefermentInDays | number | |
cutoffDate | date-time | Closing date for the credit card statement (= bill) of the organizations billing cycle. Usually this is around the 23th/24th of the month |
plannedPaymentDate | date-time | Date & time when the payment is going to be deducted (e.g. via SEPA direct debit) only if paymentType = BILL |
actualPaymentDate | date-time | Date & time when the payment is actually processed |
relatedTransactions | array | The transactions which are linked by this payment, i.e. getting paid with this payment. This array will grow in size anytime a transaction is made within the payment frequency window of the organization. It will grow until (including) the cutoffDate of the payment. |
partnerSubmissionStatus | string | Synchronisation status of the paymentNOT_SYNCED SYNCED TEMP_LOCKED LOCKED Also see two-way-sync here: 🔁 Synced |
partnerSubmissionStatusSyncedAt | date-time | Date the payment has been synced to the partner (initiated by Pliant) |
partnerSubmissionStatusTempLockedAt | date-time | Date the payment has been marked as temporary locked (initiated by partner) |
partnerSubmissionStatusLockedAt | date-time | Date the payment has been locked (initiated by partner) |
createdAt | date-time | Date & time when the payment was created either by Pliant (for bill payments) or by the organization (for top-up payments) |
updatedAt | date-time | Date & time when the payment was last updated |
Example Data
[
{
"paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"publicPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "BILL",
"method": "DIRECT_DEBIT_CORE",
"status": "PLANNED",
"amount": {
"value": 0,
"currency": "string"
},
"paymentDefermentInDays": 0,
"cutOffDate": "2023-03-22T07:54:53.033Z",
"plannedPaymentDate": "2023-03-22T07:54:53.033Z",
"actualPaymentDate": "2023-03-22T07:54:53.033Z",
"partnerSubmissionStatus": "NOT_SYNCED",
"partnerSubmissionStatusSyncedAt": "2023-03-22T07:54:53.033Z",
"partnerSubmissionStatusTempLockedAt": "2023-03-22T07:54:53.033Z",
"partnerSubmissionStatusLockedAt": "2023-03-22T07:54:53.033Z",
"createdAt": "2023-03-22T07:54:53.033Z",
"updatedAt": "2023-03-22T07:54:53.033Z"
}
]
Updated about 1 year ago