---
title: "Retrieve file"
method: GET
path: "/files/{id}"
tags: ["Files"]
---

# Retrieve file

`GET /files/{id}`

Retrieve the details of a file.

## Path parameters

- `id` string, uuid, required

## Response `200`

200

- FileDetails — A file is received from or sent to a bank. A file can be a payment file, a payment status report, an account statement, etc.
  - `id` string, required — The UUID of the file.
  - `object` 'file', required — Label used to identify this kind of object.
  - `connected_account_id` string, uuid, required — The ID of the connected account used to send or receive the file.
  - `connected_account_ids` string[], required — The IDs of the connected accounts used to send or receive the file.
  - `direction` 'outgoing' | 'incoming', required — The transfer direction for the file_id: - `outgoing` for files sent or to be sent to the bank - `incoming` for files received from the bank
  - `category` 'bank_file' | 'payment_file' | 'report_file' | 'return_request_file' | 'return_file' | 'account_report' | 'account_statement' | 'account_notification' | 'inquiry_category' | 'denied_inquiry_file' | 'denied_return_request_file' | 'error_file_format' | 'unknown_file_format' | 'forwarded_message', required — The category of the file.
  - `format` string, required — The format of the file.
  - `filename` string, required — The name of the file.
  - `size` integer, required — The size of the file, expressed in bytes.
  - `summary` object, required — A summary of the file, depending on its content.
  - `status` 'created' | 'approved' | 'canceled' | 'sent' | 'rejected' | 'processed' | 'received', required — The status of the file.
  - `bank_data` object, required — Bank data, such as message ID, in JSON `key:value` format.
    - `message_ids` string[], required
  - `status_details` string, required — The details of the status of this file, such as the rejection reason for instance.
  - `created_at` string, date-time, required — The UTC timestamp of the creation of the file.

## Other responses

- `400` — 400

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)