We added some minor improvements in the domains of cardholder and card limit endpoints

Cardholder status

Previously the cardholder status was not exposed. We improved it by:

1. adding the status property to query params & response body of GET /api/cardholders
2. adding the status property to the response body of GET /api/cardholders/{cardholderId}
3. adding a new callback CARDHOLDER_INVITED to POST /cardholders/subscription which is triggered when a member is invited.
4. extending the Callback object cardholderUpdate with status property

Possible ENUMs are:

INVITED
ACTIVE
DEACTIVATED

Card limit changes

We do now provide more granular information about card limit changes. So whenever one of the listed properties of a card is updated we trigger the CARD_LIMIT_CHANGED callback (if setup via POST /cards/subscriptions).

transactionLimit
monthlyLimit (this one is deprecated)
limit
limitRenewFrequency

We provide a new property called limitChange which includes the previous and the new values so you can easily build e.g. notifications on top of it. Please find an example below:

{
  "eventType": "CARD_LIMIT_CHANGED",
  "cardId": "...",
  "organizationId": "...",
  "cardholderId": "...",
  "type": "VIRTUAL",
  "status": "ACTIVE",
  "label": "Test",
  "limitChange": {
    "beforeChange": {
      "transactionLimit": {
        "value": 4200,
        "currency": "EUR"
      },
      "limit": {
        "value": 4200,
        "currency": "EUR"
      },
      "limitRenewFrequency": "QUARTERLY"
    },
    "afterChange": {
      "transactionLimit": {
        "value": 8400,
        "currency": "EUR"
      },
      "limit": {
        "value": 8400,
        "currency": "EUR"
      },
      "limitRenewFrequency": "QUARTERLY"
    }
  }

We added the card limit frequencies feature to our API product.

📘

This topic is especially relevant for embedded partners!

What is it about?

We added something new to our API: card limit frequencies. With this feature, you are able to set a card limit frequency while creating cards and card requests as well as fetching data regarding card limit renewal when reading card data. You can even change the card limit frequency for existing cards.

What does it mean? Per default credit cards do revert back to their limit each calendar month. With card limit frequencies you are able to control if and when a card limit renews. There is even a way to define a total limit which is never gonna be renewed at all.

How to use it?

You do have a possibility now to define a card's limit frequency when...

• ... issuing a card (Issue card) or changing card limits (Update Card limits) via limit and limitRenewFrequency properties.
• ... requesting a card (Create card request) via requestedLimit and limitRenewFrequency properties.
• ... approving a card request (Approve Card Request) via approvedLimit and limitRenewFrequency properties.

For limitRenewFrequency you can choose between:

• MONTHLY - card limit (set via limit property) refreshes every calendar month (default value)
• QUARTERLY - card limit refreshes every calendar quarter
• ANNUAL - card limit refreshes every calendar year
• TOTAL - card limit does not refresh. Once the amount is spent the card is not usable anymore.

To keep track of this for existing and new cards we added a couple of new properties to our Card Details and Card Request Details endpoints.

• limitRenewFrequency
• requestedLimit (only for Card Request Details)
• limit (only for Card Details)
• limitPeriodEnd (only for Card Details)
• limitRenewDate (only for Card Details)

❗️

With this feature we do put the monthlyLimit property to deprectated status. For now it returns the card limit (independent of the card limit frequency). As this is kind of misleading we ask you to build or adapt your implementation based on the new limit property.

Important notes:

• If you modify the card limit frequency it affects cards immediately meaning that if an existing card is changed from QUARTERLY to MONTHLY the limit will be renewed with the next calendar month already!

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:

• List of statements
• Statement details
• Statement PDF

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 to status property in response object of Transaction details
• trigger the event TRANSACTION_STATUS_CHANGED once the status of a transaction is changed to BOOKED
• 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:

• List of bills
• Bills details
• Bills PDF

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.

We simplified the way how to create mock transaction in our sandbox environment by adding an official endpoint POST /test-data/transactions.

More information on how to use it can be found here.

For our embedded partners it is now possible to create leads for Pliants onboarding team programmatically via our endpoint: POST /partner-management/lead. Please contact your partner management before starting to use it in production.