Responses

Common Responses for the object.

Get

Get Response Parameters

Response Parameters

Property Description
Id Unique identifier for the record
amount Amount, in pence, of the transaction
collection_date Collection date of the transaction, in the format of “YYYY-MM-DD”
record_id The ID of the transaction record
status Status of the transaction
submission_id ID of the submission record
transaction_code Transaction code of the transaction
type Type of the transaction

Get Response Sample - Single

Response Sample 

{
    "submissionLine": {
        "Id": "FL01YZ96J1R0WRRJNEWD",
        "amount": "0",
        "collection_date": "2022-07-14",
        "record_id": "M016DZMJN53EXEPK325",
        "status": "Successful",
        "submission_id": "FS01DNZWLJRDXQ8GQ914",
        "transaction_code": "0N",
        "type": "mandate"
    }
}

Get Response Sample - Multiple

Response Sample 

{
    "submissionLines": [
        {
            "Id": "FL01YZ96J1R0WRRJNEWD",
            "amount": "0",
            "collection_date": "2022-07-14",
            "record_id": "M016DZMJN53EXEPK325",
            "status": "Successful",
            "submission_id": "FS01DNZWLJRDXQ8GQ914",
            "transaction_code": "0N",
            "type": "mandate"
        },
        {
            "Id": "FL01D1LRPM05904JYEQG",
            "amount": "0",
            "collection_date": "2022-07-14",
            "record_id": "M01ZQ0583WG6MY86KNO",
            "status": "Successful",
            "submission_id": "FS01DNZWLJRDXQ8GQ914",
            "transaction_code": "0N",
            "type": "mandate"
        }
    ]
}