Receiptrail API Documentation
v0.2.42Comprehensive API documentation for receipt ingestion, processing, and data transformation services.
Playground
Receipt normalization and data transformation endpoints for processing raw receipt data into structured, standardized formats.
| Method | Endpoint | Description |
|---|---|---|
| POST | Test JSON Receipt /normalizer/process-json | Process a receipt JSON and extract structured data. |
| POST | Test image receipt /normalizer/process-image | Process a receipt image from URL and extract structured data Args: request: Request containing the image URL Returns: Structured receipt data. |
Receipts
Receipt ingestion endpoints for acquiring, authenticating, and validating receipt artifacts from merchant systems including POS devices, webhooks, APIs, and SFTP.
| Method | Endpoint | Description |
|---|---|---|
| POST | Submit receipts /ingestor/receipts/ingest | Endpoint for receipt ingestion from any merchant source. |
| GET | Get processed receipt /ingestor/receipts/{id} | Retrieves a specific receipt by its unique identifier. |
| GET | List processed receipts /ingestor/receipts | Retrieves a paginated list of all normalized receipts in the system. |
| GET | Get raw receipts /ingestor/ingestions/{id} | Retrieves a specific ingestion batch by its unique identifier. |
| GET | List raw receipts /ingestor/ingestions | Retrieves a paginated list of all ingestion batches in the system. |
Delivery
Receipt delivery endpoints for distributing processed receipts to partner institutions via webhooks, SFTP, file export, or streaming.
| Method | Endpoint | Description |
|---|---|---|
| GET | List deliveries /delivery/partners/{institution_code}/deliveries | Retrieve a list of delivery jobs for a specific FI partner. |
| POST | Initiate delivery /delivery/partners/{institution_code}/deliveries | Initiate a delivery job for a specific FI partner. |
| GET | Get delivery /delivery/partners/{institution_code}/deliveries/{job_id} | Retrieve detailed information about a specific delivery job, including status, progress, delivery results, and any error details. |
| DELETE | Cancel delivery /delivery/partners/{institution_code}/deliveries/{job_id} | Cancel a pending or in-progress delivery job. |
Authentication
Get started with OAuth 2.0 and Personal Access Tokens for secure API access.
Learn morePlayground
Try our receipt transformation engine live. Extract structured data from receipts instantly.
Try it nowGetting Started
Contact sales & get onboarded
Reach out to our sales team and we'll set up your partner account, configure your organization, and grant API access.
Share your receipt structure
We configure the correct mappers for your receipt format. If no mapper exists, our AI mapper automatically normalizes your data.
Choose your integration method
SFTP
Provide credentials to your receipt directory. We poll and pull receipts automatically.
API
Provide your endpoint and credentials. We poll your API to fetch receipts.
Code
Integrate directly with our API. You control when and how often to send receipts.
Data-agnostic API powered by AI
Our AI normalization engine converts any receipt format into a homogeneous, structured output — no matter how your data looks.