The File service manages the lifecycle of files in HatchPay — files you upload, files the platform generates for you (such as end-of-day transaction exports), secure time-limited downloads, and automated transfers to external systems over SFTP. Every file is scoped to your tenant and stored in isolated cloud storage.

Files

Files are categorized by how they originate. UPLOADED files are provided by you, while EOD_TRANSACTIONS files are generated by the platform as part of end-of-day settlement processing.

GET /files — list your tenant’s files.

GET /files/{file_id} — retrieve a file’s metadata, including its file_category, mime_type, size, file_status, and timestamps.

DELETE /files/{file_id} — remove a file.

Uploading & Generating Files

POST /uploads — upload a file into the platform.

POST /requests — request the platform to generate a file (for example, an export). Generation runs asynchronously; the file’s file_status reflects its progress and generated_at is set when it completes.

Downloading Securely

Rather than streaming file bytes through the API, the service issues short-lived signed URLs. Request a URL and then download directly from it; the link expires shortly after issuance.

GET /files/{file_id}/url

{
    "url": "https://storage.googleapis.com/.../signed-download-link"
}

Automated Transfers

Files can be delivered automatically to an external destination over SFTP. You store the destination credentials once as a transfer auth configuration, then the platform uses it to push files such as EOD exports.

GET /transfers/methods — list supported transfer methods (SFTP).

POST /transfers/auth-infos — store SFTP destination credentials. Credentials are encrypted at rest and redacted in responses.

GET /transfers/auth-infos and /{auth_info_id} — manage existing transfer configurations.

End-of-day transaction files are produced as part of settlement.

Previous: Communications Next: Billing & Subscriptions