GET
List deliveries
/delivery/partners/{institution_code}/deliveries
Retrieve a list of delivery jobs for a specific FI partner. Results can be filtered by status, date range, and other criteria.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| institution_code* | path | string | Institution code of the FI partner |
| start_date* | query | string (date-time) | Filter jobs created after this date |
| end_date* | query | string (date-time) | Filter jobs created before this date |
| status | query | string | Filter by delivery job status |
| merchant_code | query | string | Filter by merchant code |
Responses
200 - List of delivery jobs retrieved successfully
Schema
jobs*array
List of delivery jobs
[]
pagination*any
400 - Invalid request parameters
Schema
code*any
message*any
detailsarray
Additional details about the error
request_idstring
Request ID for tracking
"req_123456"
documentation_urlstring (uri)
URL to documentation about the error
"https://docs.receiptrail.com/errors/invalid_request"
statusinteger (int32)
HTTP status code
400
401 - Unauthorized
Schema
code*any
message*any
detailsarray
Additional details about the error
request_idstring
Request ID for tracking
"req_123456"
documentation_urlstring (uri)
URL to documentation about the error
"https://docs.receiptrail.com/errors/invalid_request"
statusinteger (int32)
HTTP status code
401
404 - FI partner not found
Schema
code*any
message*any
detailsarray
Additional details about the error
request_idstring
Request ID for tracking
"req_123456"
documentation_urlstring (uri)
URL to documentation about the error
"https://docs.receiptrail.com/errors/invalid_request"
statusinteger (int32)
HTTP status code
404
500 - Internal server error
Schema
code*any
message*any
detailsarray
Additional details about the error
request_idstring
Request ID for tracking
"req_123456"
documentation_urlstring (uri)
URL to documentation about the error
"https://docs.receiptrail.com/errors/invalid_request"
statusinteger (int32)
HTTP status code
500