Sync Scope
With this scope, the API functionality is limited to reading the current data for the available organizations (the ones the partner has been authorized for) and includes the following capabilities for the partner app:
- Read basic information about the organization (full legal name, credit limit, status, etc.)
- 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)
- Download and receive updates about receipts
This scope is relevant for partners for which:
- It is sufficient to pull data ad hoc based on explicit manual requests by the partner application or regularly from time to time (e.g. once a day).
- It is sufficient to get data on items that got actually booked on the customer organization's credit card account (i.e. settled transactions, paid bill payments, and booked fees). Pending transactions and upcoming or pending bill payments are not available in this scope, as it would be necessary to be able to receive callbacks when transaction and bill payment statuses are updated. In that case, the Expense Management scope is required.
- Partners do not want to deal with the more complicated requirements of real-time transaction and payment events being pushed via webhook (e.g. updating statuses of pending transactions; exception is receipts callback; alternatively compare the Expense Management below).
- It is not required to make any data manipulation, i.e. a simple one-way read access is sufficient.
- It is sufficient that the customers uses both apps: Pliant and partner app.
Use Case Example
The partner app is an accounting software solution. Only the transaction and payment data that actually get booked as accounting entries need to be retrieved. Since accountants will review card transactions and book the respective accounting entries batch-wise in regular intervals (e.g. monthly or weekly), a real-time data push is not required.
Updated about 1 year ago