This endpoint completes the existing "Activate Organization Authorization" and will enable you to reset and organization authorization when needed.
Redeem Cashback
The following endpoint will enable a specific organization to redeem the accumulated cashback (totally or partially), completing the "cashback flow" together with the existing endpoints.
We are exposing our FX fee data now. These enhancements improve transparency and detail for API consumers interacting with foreign exchange rates and fees through our CaaS API.
FX fee on organization & transaction and account entry entity level
FX Rate Field:
Added fx_rate field to the GET /organization endpoint, enhancing organization details by including foreign exchange rate information.
Updated the ORGANIZATION_UPDATED callback payload to include the fx_rate field. This field will now be part of the payload when an organization update is triggered, allowing partners to receive real-time updates on FX rates.
FX Fee Object:
Added fx_fee object to the GET /transaction endpoint, providing detailed foreign exchange fee information for transaction details.
Introduced the fx_fee object to the GET /account_entry endpoint, specifically for entries where type = TRANSACTION, enabling better visibility of FX fees associated with account entries.
We have made small improvements to the transaction, statements and card account entities.
Set receiptNeeded flag on on transaction level
We have added an endpoint that allows to manage the necessity to provide receipts within the Pliant platform (web apps, mobile app). Its now possible to turn receiptNeeded property to false on transaction level allowing for some automations based on e.g. card or merchant level. As API consumer you can now turn off receipts for specific merchants or cards. The endpoint is documented here: PATCH /transactions/{{transactionId}}/receiptUpload.
Balance for each card account
Previously the balance property has been only available on organization level. We have now added it to the card account entity. It can be accessed via this endpoint GET /card-accounts. More information on the topic of account limits and balanced can be found in this article.
Related transactions for statement entity
Each statement has a 1:1 relationship to account entries. It is now possible to fetch all account entries for a given statementId. We extended the existing endpoint GET /statements/{{statementId}} to fetch the details of a statement with the relatedTransaction property.
We introduced a new endpoint to retrieve account entries for a set organization. Account entries are basically all movements of a card account. The endpoint will enable you to fetch booked account movements and provide detailed account informations, together with the statements endpoint.
POST /account-entries/subscription to subscribe to the related ACCOUNT_ENTRY_CREATED event. The response payload of the callback will be the same of the GET endpoint above
We are introducing a way to retrieve the statement CSV (helpful for reconciliation) as well as an endpoint to migrate non-embedded cardholders to embedded ones (to restrict access to Pliant UIs). In addition to that, we added a new request property for deactivating cardholders and a new callback that is fired once a card is shipped by one of our card manufacturers.
Statement CSV
Until know we only exposed the monthly statement PDF including all the account movements (we call them "account entries") like credit card transactions, bill payments, direct debit reversal fees and so forth. We are now adding an endpoint that allows fetching the so called statement CSV. Usually this file is attached to the monthly billing email (next to the statement PDF) but can also be downloaded for each month using Pliant UI.
To access the file:
Call POST /statements/csv to trigger the file creation job for the specified organization, card account and date period.
You will receive a callback of type STATEMENT_CSV_DOWNLOAD_READY once the exported CSV file is ready. Do not forget to subscribe to the callback upfront! Otherwise this endpoint returns an error.
Fetch the actual file via the URL that is provided in statementFileUrl. This URL is valid for at least 1 week. After that, the file might not be available anymore. The pattern of this URL may change at any time, so do not rely on the structure of the URL. Every time you receive the callback, just use the provided URL in the callback to download the file.
Remarks to the business logic: You can specify start and end dates. In the Pliant application, for all completed months, these dates default to the first and last day of the month. For the ongoing month, the start date defaults to the first day of the month, and the end date is set to the current day.
Change cardholder type
When adding cardholders to the platform we do offer two ways
Inviting them via POST /cardholders/invite which sends out an email and asks the user to go through the registration flow (setting a password and more). This results in a user with full access to the Pliant UI (depending on role)
Registering them via POST /cardholders/register which creates an entity on the platform that can be used to issue cards (via API or UI). The user does not receive any email and is not able to access Pliant applications (web or mobile)
Internally we do handle those cardholders differently. The first ones are non-embedded cardholders while the latter ones are embedded cardholders.
We are know adding an endpoint POST /cardholders/remove-pliant-webapp-access that allows you to migrate an non-embedded cardholder to an embedded cardholder. This is especially useful if you want to restrict access to Pliant apps (web & mobile).
Some important remarks:
The endpoint asks for mandatory parameter organizatioId because in case a cardholder is the member of multiple organisations you are able to restrict only access to the specified organization. If you want to lock out a cardholder completely provide the same cardholderId in combination with multiple organizationIds.
It wont change anything in case the cardholder is in terminated status or if the cardholders role is ADMIN or OWNER.
Sometimes there is the business need to deactivate a cardholder and re-invite the cardholder with the same username (email address). This is why we are adding an optional suffix parameter when calling the above mentioned endpoint that allows API consumers to alter the username by adding a suffix like +deactivated to the email address that is stored on the platform.
Business logic:
If no suffix is applied the cardholder will be deactivated without any change of the username
If the endpoint is called for already deactivated cardholders the suffix will be applied as well.
Minor improvements
We're introducing a new event: CARD_SHIPPED. This event will be triggered when we receive confirmation from our card manufacturers that a physical card has been successfully shipped. Please note that this event is applicable only for cards designated as PHYSICAL and will not be triggered for any other card types. The payload is re-using the cardUpdate object described in our API reference for card entity.
We added the cardId to the payload of CARD_REQUEST_UPDATED callback that is triggered by the following events: CARD_REQUEST_CREATED, CARD_REQUEST_APPROVED & CARD_REQUEST_REJECTED.
Pliant is deprecating the current base URL for its API test environment, also known as sandbox or staging environment. This means you need to switch the base URL for the test environment from the currently used one to our new base URL.
This change only affects the test environment of the Pliant CaaS / Pro APIs as well as the PCI APIs.
Change for the CaaS/Pro API:
From partner-api.staging.v2.infinnitytest.com to sandbox.partner-api.getpliant.com
Example full endpoint URL after the change: GET https://sandbox.partner-api.getpliant.com/api/organizations
Change for the PCI API:
From pci-api.staging.infinnitytest.com to pci-sandbox.partner-api.getpliant.com
Example full endpoint URL after the change: GET https://pci-sandbox.partner-api.getpliant.com/card-details/widget/…/otp
Everything else stays the same!
This change only affects the test environment, NOT the production environment.
No change is planned for the production environment URLs.
No endpoint path or structure itself changes, just the base URL.
The calls are still HTTPS encrypted, as usual.
The API docs already reflect this change.
Auth0 URLs and parameters are not changed.
Why do we change?
Better readability of the base URL itself
Better scaling options on our end in the future
In 6 weeks from now, on 31st May 2024, Pliant will discontinue the routing of the old, deprecated base URL. Calls to the old URLs will fail after this point in time.
The new URLs are available immediately and you can switch within the next 6 weeks from now on.
If any questions around this change arise, please use the established communication channels.
