Credit Event - Sample - General

Credit Event - Sample - Record Creation

Credit Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
id “CR01OQW39P440XP56NXL”
event_id “HI065OW1YJVX10PX29LV”
legacy_id null
amount 918
credit_date “2024-04-11”
created_at “2024-04-09T09:18:33Z”
status “pending_submission”
submission_reference “CRRP440X”
edited_at “2024-04-09T09:18:32Z”
description “Test”
custom_reference null
event_type “credit.create”
event_source “Portal”
overriding_name null
default_narrative “”
rti null
bacs_reason_code null
bacs_description null
bacs_reference null
bacs_filename null
metadata null
client:id “CL01LG420EJ9DP1VQWR9”
created_by:id “CU01LG420EJ9VWP1VQWR”
edited_by:id “CU01LG420EJ9VWP1VQWR”
customer_account null
bank_account:id “BA01LYZ96J10E7PNEWDV”
bank_account:legacy_id null
bank_account:account_name “T User”
bank_account:account_number “*529”
bank_account:sort_code “27”
bank_account:bank_name “BANK OF IRELAND (UK) PLC”
mandate null
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” 
{
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "client": {
        "id":{VALUE}
    },
   "events":[
      {
         "id":{VALUE},
         "event_id":{VALUE},
         "legacy_id":{VALUE},
         "amount":{VALUE},
         "credit_date":{VALUE},
         "created_at":{VALUE},
         "status":{VALUE},
         "edited_by_id":{VALUE},
         "submission_reference":{VALUE},
         "edited_at":{VALUE},
         "description":{VALUE},
         "custom_reference":{VALUE},
         "event_type":{VALUE},
         "event_source":{VALUE},
         "overriding_name":{VALUE},
         "default_narrative":{VALUE},
         "rti":{VALUE},
         "bacs_reason_code":{VALUE},
         "bacs_description":{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}
         },         
         "mandate":{
             "id":{VALUE},
             "auddis":{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}
         } 
  
      }
   ]
}

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

Credit Event - Sample - Record Update

Credit Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
status “submitted”
edited_at “2024-10-24T12:10:08Z”
event_type “credit.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},
         "legacy_id":{VALUE},
         "amount":{VALUE},
         "credit_date":{VALUE},
         "created_at":{VALUE},
         "status":{VALUE},
         "edited_by_id":{VALUE},
         "submission_reference":{VALUE},
         "edited_at":{VALUE},
         "description":{VALUE},
         "custom_reference":{VALUE},
         "event_type":{VALUE},
         "event_source":{VALUE},
         "overriding_name":{VALUE},
         "default_narrative":{VALUE},
         "rti":{VALUE},
         "bacs_reason_code":{VALUE},
         "bacs_description":{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}
         },         
         "mandate":{
             "id":{VALUE},
             "auddis":{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}
         } 
  
      }
   ]
}

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