The 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	UUID of the file.
object string	The object, here `file`.
connected_account_id string	The ID of the connected account used to send or receive the file.
direction string	The transfer direction for the file: `outgoing` for files sent or to be sent to the bank `incoming` for files received from the bank
category string	The category of the file: `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 format of the file. For instance: `pain.001` `pain.002` `camt.053` `pacs.008` `pacs.002` `pacs.004` `camt.056` `camt.029`
filename string	The name of the file.
size integer	The size of the file, expressed in bytes.
summary object	A summary of the file, depending on its content.
status string	The status of the file.
status_details string	The details of the status of this file, such as the rejection reason for instance.
bank_data object	Bank data, such as message ID, in JSON `key:value` format.
created_at datetime	The UTC timestamp of the creation of the file.

Below is an example of a file:

{
  "id": "3ad331b9-12b2-48fd-ad35-203fe8b5e78e",
  "object": "file",
  "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 2022-08-01",
  "created_at": "2022-08-01T06:00:05Z"
}