The Percents Omni API is a server-to-server integration for issuers and channel partners 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 a signed result webhook after automated processing and required human review are complete.
The production documentation site is intended to be published at https://omni-api-docs.percents.com.
The public API currently includes read-only merchant and offer endpoints, a presigned file-upload endpoint, the public plaid-txn-stream input format, and the omni-txn-stream-result 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 |
| Configure credentials and issuer scope | Authentication and issuer setup |
| Synchronize merchant and offer catalogs | Offers and immutability |
| Submit transaction files | File upload workflow and Plaid format |
| Receive final processing results | Result webhooks and signature verification |
| Explore exact operations and schemas | Percents API |
| Review contract changes | Changelog |
- Read Authentication and provide Percents with the source IPs that will call the API.
- Complete the Quickstart using sandbox credentials.
- Confirm the issuer-to-channel-network association, then read Offers before storing or displaying offer terms.
- If uploading transactions, implement the upload workflow and result webhook together.
Never expose an issuer API token or webhook signing token in a browser, mobile application, logs, or source control.