Integration Options: REST API vs. SFTP
Abstract
We offer two integration options for merchant and offer data ingestion: REST API and SFTP. While we strongly recommend REST API integration for its immediacy and ease of use, SFTP remains available for partners whose needs, data volumes, or operational cadence are better suited to batch file uploads. Both options use the same JSON schema, ensuring consistency regardless of integration choice. Partners may select either method or even combine both, though we encourage picking a single primary integration path for simplicity.
Overview Table: REST API vs. SFTP
| Feature | REST API | SFTP Batch Upload |
|---|---|---|
| Recommended For | Near real-time updates, instant feedback | Large data volumes, scheduled/batch ops |
| Data Ingestion | One record per request | Full file of records per upload |
| Schema | Shared JSON schema (see docs) | Shared JSON schema (see docs) |
| Header Record | N/A | Mandatory |
| Status Field | Inferred from HTTP method | Explicit merchantStatus or offerStatus |
| Update Cadence | As changes occur (event-driven) | Daily (or as needed) |
| Error Handling | Immediate API response (HTTP code) following RFC 9457 | Errors on file processing, reported after |
| File Naming | N/A | Strict naming conventions required |
| Upload Content | Single merchant/offer per request | All current records in one file |
| Partial Updates | Yes (single record per call) | No (full dataset each time) |
| Mixing Allowed? | Yes (with care) | Yes (with care) |
| Typical Use Cases | Dynamic systems, frequent changes | Large, periodic updates, legacy flows |
Additional Notes
- Schema Parity: Both REST API and SFTP use the same JSON schema for merchants and offers, simplifying migration and consistency.
- Mixing Integrations: While possible, we advise choosing one method to avoid data conflicts.
- Offer Deletions: When offers are deleted via either method, they will remain redeemable for customers who previously activated them until the redemption window (30–45 days) expires.
If you have questions about which integration best fits your needs, contact your technical account manager for guidance.
Updated 9 days ago
What’s Next