Overview of our File Spec
We have adopted CSV over SFTP as the financial industry standard file format and secure network protocol for data transfer. This enables both engineering teams as well as non-technical personnel to easily integrate with our Collections Platform.
The following requirements are applicable to all files.
- Standard CSV format with .csv extension, UNIX line feed (\n) and UTF-8 encoding
- Monetary values are expressed as integer values in your organisation local currency
- Required values are annotated with * and exceptional cases are annotated with **
- CSV Headers and Constants are case-sensitive
Your FTP home directory contains the following directories.
| Directory | Permissions | Description |
|---|---|---|
/AccountUpload | Read & Write | Directory where you can upload new and existing accounts. For more details, see Account Upload. |
/AccountRecall | Read & Write | Directory where you can upload accounts to be recalled. For more details, see Account Recall. |
/TransactionUpload | Read & Write | Directory where you can upload account balance changes. For more details, see Transaction Upload. |
/AccountActivityReports | Read only | Directory where you can download daily account activity reports. For more details, see Account Activity Reports. |
/PaymentReports | Read only | Directory where you can download daily payment reports. For more details, see Payment Reports. |
/PayoutReports | Read only | Directory where you can download daily payout reports. For more details, see Payout Reports. |