Mandate Event - Sample - General

Mandate Event - Sample - Record Creation

Mandate Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
id “M01ZO41Y8D36RZP0GNL”
event_id “HI04ZQ0583DK33YJ6KNO”
reference “F82R62M00000002”
created_at “2024-03-28T16:24:44Z”
edited_at “2024-03-28T16:24:44Z”
status “new instruction”
i_am_the_only_account_holder true
bacs_reason_code null
bacs_description null
event_type “mandate.create”
event_source “DDMS Service”
bacs_reference null
bacs_filename null
metadata null
client:id “CL01LG420EJ9DP1VQWR9”
created_by:id “CU01LG420EJ9VWP1VQWR”
edited_by:id “CU01LG420EJ9VWP1VQWR”
customer_account:id “CA01WZQ0583EW986KNOE”
customer_account:legacy_id null
bank_account:id “BA016YQRDJZVQLPVL359”
bank_account:legacy_id null
bank_account:account_name “J Hetfield”
bank_account:account_number "*****796"
bank_account:sort_code "****51"
bank_account:bank_name “Bank of Scotland plc”
originating_bank_account:id “OB01O6YQRDJZWJVL359M”
originating_bank_account:legacy_id “CBA-0000002”
originating_bank_account:account_name “CBA - FTB - 01”
originating_bank_account:account_number “10020645”
originating_bank_account:sort_code “834600”
service_user_number:id “SN019LVZMGJ2KD8K46WE”
service_user_number:sun_number “100263”
service_user_number:sun_name “Smarterpay Test”
account_validation null 
{
    "id":{VALUE},
    "idempotency_key":{VALUE},
    "sent_at":{VALUE},
    "client":
	{ 
	    "id":{VALUE} 
	},
    "events":[
        {
            "id":{VALUE},
            "event_id":{VALUE},
            "reference":{VALUE},
            "created_at":{VALUE},
            "edited_at":{VALUE},
            "status":{VALUE},         
            "i_am_the_only_account_holder":{VALUE},         
            "bacs_reason_code":{VALUE},
            "bacs_description":{VALUE},
            "event_type":{VALUE},
            "event_source":{VALUE},
            "bacs_reference":{VALUE},
            "bacs_filename":{VALUE},
            "metadata":{VALUE},
            "created_by":{
                "id":{VALUE}
            },
            "edited_by":{
                "id":{VALUE}
            },  
            "customer_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "bank_account":{
                "id":{VALUE},
                "legacy_id":{VALUE},
                "account_name":{VALUE},
                "account_number":{VALUE},
                "sort_code":{VALUE},
                "bank_name":{VALUE}
            },         
            "originating_bank_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
                "account_name":{VALUE},
                "account_number":{VALUE},
                "sort_code":{VALUE}
            },
            "service_user_number":{
                "id":{VALUE},
                "sun_name":{VALUE},
                "sun_number":{VALUE},
            },
            "client":{
                "id":{VALUE}
            },
            "account_validation": [
                {
                    "id": {VALUE},
                    "account_name_match": {VALUE},
                    "validation_performed": {VALUE},
                    "validation_link": {VALUE},
                    "created_at": {VALUE},
                    "edited_at": {VALUE}
                }
            ]       
        }
    ]
}

Note: Property display order for documentation purposes, actual order may vary.

Mandate Event - Sample - Record Update

Mandate Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
event_id “HI04QW39P4QY2LM3856N”
edited_at “2024-11-05T07:12:20Z”
status “first collection”
event_type “mandate.update”
event_source “DDMS Service”
edited_by null 
{
    "id":{VALUE},
    "idempotency_key":{VALUE},
    "sent_at":{VALUE},
    "client":
	{ 
	    "id":{VALUE} 
	},
    "events":[
        {
            "id":{VALUE},
            "event_id":{VALUE},
            "reference":{VALUE},
            "created_at":{VALUE},
            "edited_at":{VALUE},
            "status":{VALUE},         
            "i_am_the_only_account_holder":{VALUE},         
            "bacs_reason_code":{VALUE},
            "bacs_description":{VALUE},
            "event_type":{VALUE},
            "event_source":{VALUE},
            "bacs_reference":{VALUE},
            "bacs_filename":{VALUE},
            "metadata":{VALUE},
            "created_by":{
                "id":{VALUE}
            },
            "edited_by":{
                "id":{VALUE}
            },  
            "customer_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
            },
            "bank_account":{
                "id":{VALUE},
                "legacy_id":{VALUE},
                "account_name":{VALUE},
                "account_number":{VALUE},
                "sort_code":{VALUE},
                "bank_name":{VALUE}
            },         
            "originating_bank_account":{
                "id":{VALUE},
                "legacy_id":{VALUE}
                "account_name":{VALUE},
                "account_number":{VALUE},
                "sort_code":{VALUE}
            },
            "service_user_number":{
                "id":{VALUE},
                "sun_name":{VALUE},
                "sun_number":{VALUE},
            },
            "client":{
                "id":{VALUE}
            },
            "account_validation": [
                {
                    "id": {VALUE},
                    "account_name_match": {VALUE},
                    "validation_performed": {VALUE},
                    "validation_link": {VALUE},
                    "created_at": {VALUE},
                    "edited_at": {VALUE}
                }
            ]       
        }
    ]
}

Note: Property display order for documentation purposes, actual order may vary.