v1
latestOpenAPI 3.0.02026-07-2412592575.3 KBpay-file
Upload a payment file
Uploads a payment file for processing. Requires pay_file:write scope.
post/pay-file/upload-file
Response
Successful Pay File Upload Response
Example response
{
"data": {
"id": "1198df97-7a0f-4f79-bd32-81bbe84b55b1",
"fileName": "payments-2024.json",
"fileHash": "jH4+P5eCoXE2tm0eEQTKOTHcYZxd9Uft+swyF8tF8Iw=",
"transactionCount": 2,
"controlSum": "2500.60",
"fileType": "json",
"createdAt": "2024-03-01T00:00:00Z",
"expiredAt": "2024-03-01T00:00:00Z",
"fileData": "{\n \"transactions\": [\n {\n \"accountName\": \"John Smith\",\n \"accountNumber\": \"12345678\",\n \"sortCode\": \"40-35-21\",\n \"reference\": \"INV2024001\",\n \"amount\": 1250.00,\n \"date\": \"2024-01-15\"\n },\n {\n \"accountName\": \"Sarah Wilson\",\n \"accountNumber\": \"87654321\",\n \"sortCode\": \"20-94-63\",\n \"reference\": \"RENT-JAN24\",\n \"amount\": 850.00,\n \"date\": \"2024-01-01\"\n },\n {\n \"accountName\": \"Coffee Bros Ltd\",\n \"accountNumber\": \"45678912\",\n \"sortCode\": \"30-91-45\",\n \"reference\": \"SUPPLIER-CB122\",\n \"amount\": 432.50,\n \"date\": \"2024-01-22\"\n },\n {\n \"accountName\": \"David Thompson\",\n \"accountNumber\": \"98765432\",\n \"sortCode\": \"60-83-75\",\n \"reference\": \"CONSULTANCY-Q1\",\n \"amount\": 2750.00,\n \"date\": \"2024-02-01\"\n }\n ]\n}\n",
"fileByteSize": 836,
"providerId": "fa37a6ecc38eea38bdf3dd0fcb68fab"
}
}