File object

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. The Numeral API allows you to list, approve, and download files.

Attribute	Description
id string	The file ID.
object string	Always `file`.
connected_account_ids array[string]	The IDs of the connected accounts linked to this file.
~~connected_account_id~~ (deprecated) string	The ID of the connected account used to send or receive the file. This attribute has been deprecated and received by `connected_account_ids`as a file can be linked to more than one connected account.
direction string	The file direction, either`outgoing` for files sent or to be sent to the bank or `incoming` for files received from the bank.
category string	The file 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`
format string	The file format. For instance: `pain.001` `pain.002` `camt.052` `camt.053` `camt.054` `pacs.008` `pacs.003` `pacs.002` `pacs.004` `pacs.007` `camt.056` `camt.029` `pacs.028` `camt.027` `camt.087` `proprietary.xxx`
filename string	The file name.
size integer	The file size in bytes.
summary object	A summary of the file, depending on its content.
status string	The file status.
status_details string	The file status details, such as the rejection reason.
bank_data object	Bank data in JSON `key:value` format.
created_at datetime	The file creation UTC timestamp.

Below is an example of a file:

{
   "id": "3ad331b9-12b2-48fd-ad35-203fe8b5e78e",
   "object": "file",
   "connected_account_ids":[
     "f1c51532-1d11-4a33-aee0-592db244c76f",
     "b2de8b54-e81d-4fb7-bb26-536d8d671c18"
   ],
   "connected_account_id": "f1c51532-1d11-4a33-aee0-592db244c76f",
   "direction": "outgoing",
   "category": "payment_file",
   "format": "pain.001",
   "filename": "SFPP30X40.3ad331b9-12b2-48fd-ad35-203fe8b5e78e.1659349967",
   "size": 2234,
   "summary": {},
   "status": "sent",
   "bank_data": {
      "message_ids": [
         "211012231391882"
      ]
   },
   "status_details": "generated on 2024-08-01",
   "created_at": "2024-08-01T06:00:05Z"
}