Statements & booking date
We have been adding new endpoints for credit card statements based on calendar month as well as additional properties/ENUMs for transactions entity: booking date (bookedAt
) and BOOKED
as value for property (status
).
Bills are statements now
In the last couple of weeks, we reworked our billing logic under the hood completely.
This allows us to enable billing periods based on the calendar months, and the statement PDFs generated at the end of the billing periods will cover the transactions and payments from the 1st of the month to the end of the month.
Accompanying those improvements in our backend we added three new endpoints to get data for your customer's credit card statements:
In addition to that, you are able to subscribe to and unsubscribe from the available events for statement callbacks:
- Create Callback (https://partner.getpliant.com/reference/createstatementsubscription-1)
- Delete Callback (https://partner.getpliant.com/reference/removestatmentsubscription-1)
Booking date
In addition to the new endpoints, we added data about the booking date of a transaction, which is going forward the date that defines to which statement period the transaction is being assigned to.
We
- added the property
bookedAt
to response object of Transaction details - added a new ENUM value
BOOKED
tostatus
property in response object of Transaction details - trigger the event
TRANSACTION_STATUS_CHANGED
once the status of a transaction is changed toBOOKED
- added a new ENUM value BOOKED to the status filter in the request params of List of transactions
Migration
As this is something that has been requested a lot, we aim to migrate all organizations in 01/2023. What does migration mean?
(1) For migrated organizations ...
- 24 Dec - 23 Jan will be the last _irregula_r billing period for the organizations
- Just after this period, we’ll have a transition (stub) billing period between 24 Jan - 31 Jan. And on the 24 of Jan, the organizations will start seeing a new Billing page in our system
- Starting 1 Feb, the organizations will have a calendar month-based billing period
(1) The following endpoints will not work anymore:
We have already marked them as deprecated. If you are currently implementing our partner API please use the now already available statement endpoints listed above.
(2) Transactions will be included in the monthly statements based on their booking date and the properties mentioned above will be populated accordingly.
If you are currently using any of the endpoints above or are currently in the process of implementing them please let us know (via your partner manager) if you are able to reflect the changes in your systems until 6th of January.