The Percents Omni API is a server-to-server integration for issuers that need to:
- discover the merchants and card-linked offers available to their program;
- upload transaction files using an agreed public or private format; and
- receive signed results for file validation and processing.
The public API currently includes read-only merchant and offer endpoints, a presigned file-upload endpoint, the native percents-txn-stream CSV/JSON format, the existing Plaid JSON format, issuer-scoped file status/list endpoints, and the FileUploadProcessingResult webhook.
Some partners have privately agreed file formats. Those formats may be accepted for an enabled issuer, but a format is not part of the public contract unless it appears in this documentation and the Percents API reference.
| If you need to... | Start with... |
|---|---|
| Understand the integration lifecycle and environments | Integration overview |
| Make your first authenticated sandbox calls | Quickstart |
| Choose source-IP allowlisting or mTLS and configure credentials | Authentication, Trusted Server Connection, and issuer setup |
| Coordinate sandbox integration validation | Sandbox access |
| Synchronize merchant and offer catalogs | Offers and immutability |
| Submit transaction files | File upload workflow and native format |
| Reconcile file validation and processing | Processing-result webhook and Webhook Signing |
| Explore exact operations and schemas | Percents API |
| Review contract changes | Changelog |
- Read Authentication and choose either source-IP allowlisting or Trusted Server Connection for each environment.
- Complete the Quickstart using sandbox credentials.
- Confirm issuer setup, then read Offers before storing or displaying offer terms.
- If uploading transactions, implement the upload workflow and processing-result webhook together.
Never expose an entity API token or webhook signing token in a browser, mobile application, logs, or source control.