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.

Parameters

NameLocationTypeDescription
institution_code*pathstringInstitution code of the FI partner
job_id*pathstring (uuid)Unique identifier of the delivery job

Responses

200 - Delivery job details retrieved successfully

Schema

job_id*string (uuid)

Unique identifier for the delivery job

"770e8400-e29b-41d4-a716-446655440000"
status*string

Current status of the delivery job

"COMPLETED"
created_at*string (date-time)

Timestamp when the job was created

"2024-01-15T10:30:00Z"
updated_atstring (date-time)

Last timestamp when the job was updated

"2024-01-15T11:45:00Z"
completed_atstring (date-time)

Timestamp when the job was completed (if applicable)

"2024-01-15T11:45:00Z"
institution_codestring

Institution code of the FI partner

"CHASE_US"
delivery_config_idstring (uuid)

ID of the delivery configuration being used

"550e8400-e29b-41d4-a716-446655440000"
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