JSON
Purpose
Paygate can automatically remove errors in submission files during the pre-submission validation stage. You can export lines that have been removed from a submission file in a JSON formayed file.
This page describes the format of the JSON file.
General
General format: Array of JSON object
[
{
"submissionId":"3b49accf-1057-4b62-b6c3-f5a0d0232a36",
"fileNumber":1,
"recordNumber":10,
"paygateId":"f5320035-6da8-4712-95a4-bcb8af53a501",
"thirdPartyAccountName":"ACCOUNT NAME 9",
"thirdPartyAccountNumber":"11111111",
"thirdPartySortCode":"111111",
"thirdPartyAccountType":"0",
"transactionCode":"99",
"freeFormat":"0000",
"amount":0,
"userReference":"TEST9",
"originatorAccountName":"HALIFAX",
"originatorAccountNumber":"22222222",
"originatorSortCode":"222222",
"processingDate":"",
"removalReason":"The payment amount for record 10 Name: 'ACCOUNT NAME 9', sort code: '111111', account number: '11111111' is zero so the payment was removed from your submission.",
"messageSeverity":"Warning",
"messageSeverityValue":2,
"amountText":"0.00"
}
]
Fields
Name | Description | Type | Format | Notes |
---|---|---|---|---|
submissionId | Submission ID | UUID | 36a | The unique ID of the submission assigned by Paygate |
fileNumber | File Number | Int | 4n | The number of the block or file within the submission |
recordNumber | Record Number | Int | 7n | The record number within the file |
paygateId | Paygate ID | UUID | 36a | A unique ID the represents the customer |
thirdPartyAccountName | Third Party Account Name | String | 18a | |
thirdPartyAccountNumber | Third Party Account Number | String | 8n | 11223344 |
thirdPartySortCode | Third Party Sort Code | String | 6n | 112233 |
thirdPartyAccountType | Third Party Account Type | Int | 1n | 0 |
transactionCode | Transaction Code | String | 2a | The BACS Transaction code: 99, 17, etc |
freeFormat | Free Format | String | 4a | Usually 0000 or space filled. |
amount | Amount | Number | Decimal amount of the transaction | |
userReference | Service User Reference | String | 18a | |
originatorAccountName | Originator Account Name | String | 18a | |
originatorAccountNumber | Originator Account Number | String | 8a | |
originatorSortCode | Originator SortCode | String | 6a | |
processingDate | Processing Date | String | Optional | |
removalReason | Removal Reason | String | 1024a | The message created by the validation engine provided the removal reason |
messageSeverity | Message Severity | String | 8a | The validation engine severity level. Fix, Warning |
messageSeverityValue | Message Severity Value | Int | ||
amountText | Amount Text | String | 64a | Can be ignored |