DELETE
Cancel delivery
/delivery/partners/{institution_code}/deliveries/{job_id}
Cancel a pending or in-progress delivery job. Completed or failed jobs cannot be cancelled.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| institution_code* | path | string | Institution code of the FI partner |
| job_id* | path | string (uuid) | Unique identifier of the delivery job |
Responses
204 - Delivery job cancelled successfully
400 - Job cannot be cancelled (already completed/failed)
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 - Delivery job 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