Supported file formats
Less than to read
Supported file formats
When interacting with the API, it’s important to know what file formats we currently support, and have a way to check for new supported file formats that we can process.
Calling the /fileformats endpoint:
[Domain URL]/fileformats
The supported file formats endpoint is a public endpoint, and doesn’t require authentication.
Accounts supported
You’ll see within the supported file formats response an ‘accountsSupported’ field. This shows if the file format supports multi or single Bank Account importing. This allows Provider API to know where the principleId lock should occur (either at Organisation level or Bank Account level). For example, currently CAMT053 is the only file format which supports multi account. This means that a lock at the organisation level will occur during an import as potentially multiple bank accounts will be imported. This means two imports for the same organisation at the same time will enter a queue.
Supported file formats response
{
"data": [
{
"fileFormat": "CAMT053#v1",
"description": "CAMT053-format XML file",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"xml",
"txt"
],
"accountsSupported": "multi"
},
{
"fileFormat": "JSON#v0",
"description": "JSON-format file; for TESTING ONLY",
"variant": "",
"version": "0",
"maxFileSize": 250000000,
"fileExtensions": [
"json"
],
"accountsSupported": "single"
},
{
"fileFormat": "QIF#v1",
"description": "QIF-format file",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"qif",
"txt"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular3column#v1",
"description": "Mapping for a 3 column CSV file where the Amount is a signed field indicating Debit(-) or Credits(+). Minimum requirement is for a date, description and amount.",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"csv",
"txt"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular3column#xls#v1",
"description": "Mapping for a 3 column XLS file where the Amount is a signed field indicating Debit(-) or Credits(+). Minimum requirement is for a date, description and amount.",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"xls"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular3column#xlsx#v1",
"description": "Mapping for a 3 column XLSX file where the Amount is a signed field indicating Debit(-) or Credits(+). Minimum requirement is for a date, description and amount.",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"xlsx"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular4column#v1",
"description": "Mapping for a 4 column CSV file where the Amount is in either a Credit or Debit column. Minimum requirement is for a date, description and credit amount and debit amount.",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"csv",
"txt"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular4column#xls#v1",
"description": "Mapping for a 4 column XLS file where the Amount is in either a Credit or Debit column. Minimum requirement is for a date, description and credit amount and debit amount.",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"xls"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular4column#xlsx#v1",
"description": "Mapping for a 4 column XLSX file where the Amount is in either a Credit or Debit column. Minimum requirement is for a date, description and credit amount and debit amount.",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"xlsx"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular#v2",
"description": "Mapping for a v2 3 or 4 column CSV file.",
"variant": "",
"version": "2",
"maxFileSize": 250000000,
"fileExtensions": [
"csv",
"txt"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular#xls#v2",
"description": "Mapping for a v2 3 or 4 column XLS file.",
"variant": "",
"version": "2",
"maxFileSize": 250000000,
"fileExtensions": [
"xls"
],
"accountsSupported": "single"
},
{
"fileFormat": "Tabular#xlsx#v2",
"description": "Mapping for a v2 3 or 4 column XLSX file.",
"variant": "",
"version": "2",
"maxFileSize": 250000000,
"fileExtensions": [
"xlsx"
],
"accountsSupported": "single"
},
{
"fileFormat": "XML#OFX#v1",
"description": "Mapping for an OFX file",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"ofx"
],
"accountsSupported": "single"
},
{
"fileFormat": "XML#QBO#v1",
"description": "Mapping for an QBO file",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"qbo"
],
"accountsSupported": "single"
},
{
"fileFormat": "XML#QFX#v1",
"description": "Mapping for a QFX file",
"variant": "",
"version": "1",
"maxFileSize": 250000000,
"fileExtensions": [
"qfx"
],
"accountsSupported": "single"
}
],
"links": null,
"meta": {},
"error": null
}