pay-file

Upload a payment file

Changed on

Uploads a payment file for processing. Requires pay_file:write scope.

post/pay-file/upload-file

Request

  • Base URL
    https://identity.moneyhub.co.uk
  • URL
    https://identity.moneyhub.co.uk/pay-file/upload-file
  • Auth
    API key in header Authorization

Request body multipart/form-data

filestring binary required

The payment file to upload (CSV, XML, or JSON)

transactionCountinteger required

The number of transactions in the file

controlSumstring required

The total value of all transactions in the file

providerIdstring required

The ID of the destination provider (bank) for the file

Response

Successful Pay File Upload Response

metaobject

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"
  }
}

Changes

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status