Overview: Sync Scope
Introduction
This scope offers real-time notifications on events in relation to card transactions. More specifically, it includes the following capabilities:
- Read basic information about the organization (full legal name and status)
- Read cardholder data (title, name, email address, mobile number, status)
- Read basic card data (no limit and spending data, no card security details)
- Read account entry data (transactions, platform fees and bill payments)
- Read and receive updates about transaction data, post comments
- Read and receive updates about bill payment data
- Mark transactions and bill payments as submitted (for review) and exported
- Download, upload and receive updates about receipts
Is this the right scope for me?
This scope is relevant for partners that:
- want to fully integrate a real-time experience regarding card transactions into their own app.
- aim for seamless integration between the Pliant apps and the partner app, ideally with a real-time two-way sync regarding transaction statuses (e.g. regarding export status from partner app) and receipts uploaded for certain transactions (so tracking of receipt completeness can also be done via the pliant admin app).
- need to allow customers to opt for a partial sync of card transactions, as the customer may not require/want all transactions to be synced to the partner app (although a full sync is the default setting; see more details below).
- want to leave the management of cardholders and cards to the Pliant side.
Use Case Example
A partnering expense management app wants to use push notifications to notify users about new card transactions for which receipts shall be uploaded in the partner app. That way, receipts can be more conveniently uploaded at the POS right when the cardholder pays with the card. Customers can then use the partner app to export card transactions along with expenses paid with other payment methods (e.g. cash, invoice) into their accounting system.
Two-Way Sync
As mentioned above, with this scope the aim is to create a seamless integration experience between the Pliant app and the partner app that can compete effectively with e.g. all-in-one solutions. To achieve this, it is to a certain extent required that data not only flows from the Pliant app to the partner app but also vice versa.
| Receipts | Since the Pliant app has receipt tracking capabilities and customers may choose to upload receipts on either the Pliant or the partner app’s side, the partner should not only pull new receipts uploaded to Pliant but also push receipts uploaded on their side to Pliant via the API. |
| Comments | If comments are made in the partner app as the primary touchpoint for the cardholder to handle expenses, it can be beneficial to sync those comments back to the Pliant platform, so a) the cardholder also has them in their Pliant cardholder app and b) they can be reviewed along with e.g. the receipt by an accountant when checking the completeness of receipts in the Pliant admin app. |
| Partner Submission Status | See details here |
Full or Partial Sync
The default full sync will share every card's transaction with the partner. It is also possible that a customer's organization decide for a partial sync, e.g. just syncing data for a subset of cards.
In this case, the account entries and bill payment endpoints will not be available (or rather not return any data). Also, for the partial sync option, it is possible to sync and unsync individual transactions as selected by users. To unsync transactions, the transaction entry can either be deleted in the partner app (upon partner should send a call to mark the transaction as “unsynced”) or the unsync action can be triggered from the Pliant app which triggers a callback event to the partner app which the partner app should react to by deleting the transaction entry and confirm the deletion in the response to the callback.
Updated 7 months ago