Receiptrail
POST

Initiate delivery

/delivery/partners/{institution_code}/deliveries

Initiate a delivery job for a specific FI partner. The delivery service will: 1. Retrieve the FI partner's delivery configurations from the Onboarding Service 2. Apply the specified filters to select receipts for delivery 3. Execute delivery according to the configured delivery strategy 4. Track job progress and status **Delivery Types Supported:** - **webhook**: Deliver receipts via HTTP POST to configured endpoint - **sftp**: Upload receipt files to configured SFTP server - **file**: Generate and deliver receipt files to configured location - **stream**: Stream receipts to configured streaming endpoint

Parameters

NameLocationTypeDescription
institution_code*pathstringInstitution code of the FI partner (from Onboarding Service)

Request Body

Required

Schema

delivery_config_id*string (uuid)

ID of the delivery configuration to use (from Onboarding Service)

"550e8400-e29b-41d4-a716-446655440000"
filters*any

Responses

202 - Delivery job initiated 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

"PENDING"
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-15T10:30: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"
400 - Invalid request - check filters and 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 or no delivery configurations available

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