Delivery
A delivery is a file that is sent to FarPay, that is to be processed.
It is based on the principles of communication like using SFTP, but with the added benefit of being able to send the file in a more fluent way, only using HTTPS.
The anatomy of a delivery
A delivery is specified with a set of parameters, stating the contents of the file, that is sent to FarPay. The delivery is specified with the following parameters:
Parameter | Description |
---|---|
DeliveryType | The type of delivery, e.g. invoice, agreement, statement, etc. |
DeliveryFormat | The format of the file, e.g. XML, OIOUBL, BS Payment file, etc. |
File | The file that is to be sent to FarPay, with the filename and the content, remark that in bulk and fast processing, the File should not be attached initially. |
Example
{
"DeliveryType": "Invoice",
"DeliveryFormat": "FarPayXml",
"File": {
"Filename": "myFileName.xml",
"Data": "<base64 file content>*"
}