Overview: Sync Scope

Introduction

This scope enables near-real-time notifications for events related to card transactions. The capabilities are documented here.

Is This the Right Scope for Me?

This scope is relevant for partners that:

Near-Real-Time Integration: Want to fully integrate a near-real-time experience for card transactions into their app.
Seamless Integration: Aim to create a seamless two-way sync experience between Pliant apps and the partner app (e.g., syncing transaction statuses and receipt uploads).
Partial Sync Option: Need to allow customers to opt for a partial sync of card transactions while defaulting to a full sync.
Cardholder & Card Management: Prefer leaving the management of cardholders and cards to Pliant.

Use Case Example

Expense Management Integration

A partnering expense management app can use push notifications to notify users about new card transactions requiring receipts. This allows receipts to be conveniently uploaded immediately at the POS when the cardholder pays with a card. The partner app can then export card transactions along with expenses paid via other payment methods (e.g., cash, invoice) into the customer’s accounting system.

Two-Way Sync

To provide a seamless integration experience that competes with all-in-one solutions, this scope enables two-way data flow between the Pliant app and the partner app.

Feature	Details
Receipts	Since Pliant supports receipt tracking, partners should: - Pull new receipts uploaded to Pliant. - Push receipts uploaded on the partner app to Pliant via the API, ensuring consistency across both platforms.
Comments	Sync comments made in the partner app back to the Pliant platform. This ensures: - Cardholders have access to the comments in their Pliant app. - Accountants can review the comments alongside receipts in the Pliant admin app when verifying completeness.
Partner Submission Status	For more details, see Partner Submission Status.

Full or Partial Sync

Full Sync (Default):
By default, every card's transaction is shared with the partner.
Partial Sync:
Customers can opt for a partial sync, where only data for a subset of cards is shared.
- For partial syncs, the account entry and bill payment endpoints will not return data.
- Individual transactions can also be synced or unsynced based on user selection:
  - Unsyncing in the Partner App:
    Partners should mark the transaction as "unsynced" via an API call when the transaction entry is deleted in the partner app.
  - Unsyncing in the Pliant App:
    This action triggers a callback event to the partner app, which must delete the transaction entry and confirm the deletion in the callback response.