Bank Account Event - Sample - General

Bank Account Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
account_name “James Hetfield”
account_number “29823529”
bacs_description null
bacs_reason_code null
bacs_reference null
bacs_filename null
bank_name “BANK OF IRELAND (UK) PLC”
client:id “CL010KL45YJ6ZQJZ2DQR”
created_at “2024-04-11T12:01:28Z”
created_by:id “CU01G420EJ9OOD81VQWR”
credits_allowed false
currency_code “GBP”
custom_reference null
customer_account:id “CA01O6DZMJNM140PK325”
customer_account:legacy_id null
debits_allowed true
edited_at “2024-04-11T12:01:28Z”
edited_by:id “CU01G420EJ9OOD81VQWR”
enabled true
event_source “Portal”
event_type “bank_account.create”
id “BA016DZMJN7MQVEM8K32”
event_id “HI01ZMGJ25ZMWRRDJK46”
legacy_id null
sort_code “902127”
metadata null
Modulus_Check:AccountNumber *529”
Modulus_Check:AccountCodeOK true
Modulus_Check:BankName “BANK OF IRELAND (UK) PLC”
Modulus_Check:BranchAddress1 “4-8 High Street”
Modulus_Check:BranchAddress2 “”
Modulus_Check:BranchAddress3 “”
Modulus_Check:BranchAddress4 “”
Modulus_Check:BranchAddressTown “Belfast”
Modulus_Check:BranchAddressPostCode “BT1 2BA”
Modulus_Check:BranchTitle “BELFAST CITY BRANCH”
Modulus_Check:CreditsAllowedOK true
Modulus_Check:DirectDebitsOK true
Modulus_Check:DirectDebitInstructionOK true
Modulus_Check:SortCode 27”
Modulus_Check:SortCodeOK true
Modulus_Check:TelephoneNumber “028 90244901”
{
   "client":{ 
      "id":{VALUE} 
   },
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "events":[
      {
	 "account_name":{VALUE},
         "account_number":{VALUE},
	 "bacs_description":{VALUE},
	 "bacs_reason_code":{VALUE},         
         "bacs_reference":{VALUE},
         "bacs_filename":{VALUE},
	 "bank_name":{VALUE}, 
         "client":{
            "id":{VALUE}
         },        
         "created_at":{VALUE},
         "created_by":{
            "id":{VALUE}
         },
	 "custom_reference":{VALUE},   
         "customer_account":{
            "id":{VALUE},
            "legacy_id":{VALUE}
         },
         "edited_at":{VALUE},
	 "edited_by":{
            "id":{VALUE}
         },
         "enabled":{VALUE},
	 "event_source":{VALUE},
         "event_type":{VALUE},
         "id":{VALUE},
         "event_id":{VALUE},
         "legacy_id":{VALUE},
         "currency_code":{VALUE},
         "sort_code":{VALUE},
         "metadata":{VALUE},
         "debits_allowed":{VALUE},
         "credits_allowed":{VALUE},
         "Modulus_Check":{
            "AccountNumber":{VALUE},
            "AccountCodeOK":{VALUE},
            "BankName":{VALUE},
            "BranchAddress1":{VALUE},
            "BranchAddress2":{VALUE},
            "BranchAddress3":{VALUE},
            "BranchAddress4":{VALUE},
	    "BranchAddressTown":{VALUE},
            "BranchAddressPostCode":{VALUE},
	    "BranchTitle":{VALUE},
	    "CreditsAllowedOK":{VALUE}
            "DirectDebitsOK":{VALUE},
            "DirectDebitInstructionOK":{VALUE},
	    "SortCode":{VALUE},
            "SortCodeOK":{VALUE},
            "TelephoneNumber":{VALUE},
         }
      }
   ]
}

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

Bank Account Event - Structure

The fields that have been updated for this webhook are:

Field Sample Value
credits_allowed false
edited_at “2024-11-04T15:44:58Z”
edited_by null
event_source API
event_type “bank_account.update”
{
   "client":{ 
      "id":{VALUE} 
   },
   "id":{VALUE},
   "idempotency_key":{VALUE},
   "sent_at":{VALUE},
   "events":[
      {
	 "account_name":{VALUE},
         "account_number":{VALUE},
	 "bacs_description":{VALUE},
	 "bacs_reason_code":{VALUE},         
         "bacs_reference":{VALUE},
         "bacs_filename":{VALUE},
	 "bank_name":{VALUE}, 
         "client":{
            "id":{VALUE}
         },        
         "created_at":{VALUE},
         "created_by":{
            "id":{VALUE}
         },
	 "custom_reference":{VALUE},   
         "customer_account":{
            "id":{VALUE},
            "legacy_id":{VALUE}
         },
         "edited_at":{VALUE},
	 "edited_by":{
            "id":{VALUE}
         },
         "enabled":{VALUE},
	 "event_source":{VALUE},
         "event_type":{VALUE},
         "id":{VALUE},
         "event_id":{VALUE},
         "legacy_id":{VALUE},
         "currency_code":{VALUE},
         "sort_code":{VALUE},
         "metadata":{VALUE},
         "debits_allowed":{VALUE},
         "credits_allowed":{VALUE},
         "Modulus_Check":{
            "AccountNumber":{VALUE},
            "AccountCodeOK":{VALUE},
            "BankName":{VALUE},
            "BranchAddress1":{VALUE},
            "BranchAddress2":{VALUE},
            "BranchAddress3":{VALUE},
            "BranchAddress4":{VALUE},
	    "BranchAddressTown":{VALUE},
            "BranchAddressPostCode":{VALUE},
	    "BranchTitle":{VALUE},
	    "CreditsAllowedOK":{VALUE}
            "DirectDebitsOK":{VALUE},
            "DirectDebitInstructionOK":{VALUE},
	    "SortCode":{VALUE},
            "SortCodeOK":{VALUE},
            "TelephoneNumber":{VALUE},
         }
      }
   ]
}

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

  • Last modified: 2024/11/05 12:32