The file object

A file is a file 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.

AttributeDescription
id
string
UUID of the file.
object
string
The object, here file.
connected_account
string
ID of the connected account. The connected is the 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 in bytes of the file.
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 the rejection reason.
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.
items
array[object]
The items included in this file, returned when using the Retrieve a file's items feature. Items can be payment orders, incoming payments, returns, return requests, account reports, and transactions, depending on the file. Items are returned in full, with the same format as the corresponding objects.

Below is an example of a file:

{
  "id": "dc01ab8c-f7fe-40ac-890f-3d56a4e8779e",
  "object": "file",
  "connected_account": "22222222-0000-0000-0000-000000000001",
  "direction": "outgoing",
  "category": "report_file",
  "format": "pacs.002",
  "filename": "211012231391Wadz.1634050279.xml",
  "size": 2234,
  "summary": {},
  "status": "sent",
  "bank_data": {
    "message_id": "211012231391Wadz"
  },
  "status_details": "Automatically approved",
  "created_at": "2021-10-12T14:51:19.775402Z"
}