v1
latestOpenAPI 3.1.02026-07-24180245513.9 KBFiles
List files
List and filter files.
get/files
Query parameters
limitinteger
starting_afterstring uuid
The ID of the object from which your list request will start. It is not included in the result.
sort_order'asc' | 'desc'
Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.
start_datestring date
The creation date of the file.
end_datestring date
The creation date of the file.
status'created' | 'approved' | 'canceled' | 'sent' | 'rejected' | 'processed' | 'received'
The status of the file.
The status of 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' | 'forwarded_message'
The category of the file.
The category of the file.
direction'incoming' | 'outgoing'
The direction of the file.
The direction of the file.
format'pain.001' | 'pain.002' | 'pain.008' | 'pacs.002' | 'pacs.003' | 'pacs.004' | 'pacs.007' | 'pacs.008' | 'pacs.028' | 'camt.027' | 'camt.029' | 'camt.052' | 'camt.053' | 'camt.054' | 'camt.056' | 'camt.087' | 'mt.950' | 'head.002' | 'error.format' | 'unknown.format' | 'multiple.formats' | 'custom.format'
The format of the file.
The format of the file.
connected_account_idstring uuid
The ID of the connected account used to send or receive the file.
Response
200
Example response
{
"records": [
{
"id": "3ad331b9-12b2-48fd-ad35-203fe8b5e78e",
"object": "file",
"connected_account_ids": [
"6669205e-e306-4b44-bf40-0475899eeb60"
],
"direction": "outgoing",
"format": "pain.001",
"filename": "SFPP30X40.3ad331b9-12b2-48fd-ad35-203fe8b5e78e.1659349967",
"size": 2234,
"bank_data": {
"message_ids": [
"211012231391882"
]
},
"status_details": "generated on 2022-08-01",
"created_at": "2022-08-01T06:00:05Z"
}
]
}