Bank Account Webhooks

Webhook structure and samples for Customer Bank Accounts.

Contents
Bank Account Webhook - Structure
Bank Account Webhook - Samples

{
 "events":
 [
  {
    "id" : {EVENTID},  
    "bank_account" : {BANKACCOUNT},  
    "created_at" : {CREATEDDATE}, 
    "resource_type": {BANKACCOUNT},
    "description" : {DESCRIPTION},  
    "event_source": {EVENTSOURCE},
    "account_number" : {ACCOUNTNUMBER},  
    "sort_code" : {SORTCODE},  
    "account_name" : {ACCOUNTNAME},  
    "currency" : {CURRENCY},  
    "enabled" : {ENABLED},  
    "bank_name" : {BANKNAME},  
    "customer_account" : {CUSTOMERACCOUNT},  
    "bacs_reason_code" : {BACSCODE},  
    "bacs_description" : {BACSDESCRIPTION},  
    "bacs_reference" : {BACSREFERENCE},  
    "bacs_filename" : {BACSFILENAME},  
    "custom_reference" : {CUSTOMREFERENCE}
  }
 ]
}

Webhooks are sent out of SmarterPay Cloud as a JSON array.
The JSON Syntax Rules are:

Data is in name/value pairs, for example {“id” : “EV000003432”}.
Data is separated by commas.
Curly braces hold objects.
Square brackets hold arrays.

Property	Variable	Description	Empty Values (1)	Format	Example
id	{EVENTID}	The ID of the Webhook Event.	No.	String.	“EV000003432”
bank_account	{BANKACCOUNT}	The ID of the Bank Account.	No.	String.	“ACC00034992”
created_at	{CREATEDDATE}	The Date that event was created.	No.	ISO8601.	“2020-12-22T08:05:00.000Z”
resource_type	{RESOURCETYPE}	The Resource type will be bank_account.	No.	String.	“bank_account”
description	{DESCRIPTION}	The description of Webhook Event.	No.	String.	“SMP Service - Bank Account inserted”
event_source	{EVENTSOURCE}	The Event code that triggered the sending of the Webhook.	No.	Integer.	“10022091”
account_number	{ACCOUNTNUMBER}	Account Number comprising of 8 numbers (2).	No.	Integer.	“*****678”
sort_code	{SORTCODE}	Sort Code comprising of 6 numbers (3).	No.	Integer.	“****56”
account_name	{ACCOUNTNAME}	The Account Name of the customer.	No.	String.	“Bruce Dickenson”
currency	{CURRENCY}	The primary currency for the account. Will be GBP.	No.	String.	“GBP”
enabled	{ENABLED}	If the account is enabled or disabled.	No.	string.	“true”
bank_name	{BANKNAME}	The name of the bank.	No.	String.	“NATIONWIDE BUILDING SOCIETY”
customer_account	{CUSTOMERACCOUNT}	The Customer Account that the Mandate belongs to, if set.	Yes.	String.	“CUST00032041”
bacs_reason_code	{BACSCODE}	The BACS Rejection Reason Code.	Yes.	String.	“ADDACS2”
bacs_description	{BACSDESCRIPTION}	The BACS Rejection Description.	Yes.	String.	“payer deceased”
bacs_reference	{BACSREFERENCE}	The BACS Reference.	Yes.	String.	“XYZ0012345-0012345”
bacs_filename	{BACSFILENAME}	The BACS Rejection File Name.	Yes.	String.	“Addacs020419111111”
custom_reference	{CUSTOMREFERENCE}	The Custom reference.	Yes.	String.	“Payment Run 33”

Notes:
(1) Empty Values - The property will always be in the Webhook, however the value of the property may be an empty string (“”).
(2) Depending on the setup for your client this number may be the full number, “12345678”, or a masked number “*****678”.
(3) Depending on the setup for your client this number may be the full number, “123456”, or a masked number “****56”.

Property	Possible Values
enabled	false
	true

Quick Links
Bank Account Webhook - Sample - API Action
Bank Account Webhook - Sample - BACS rejection codes - ADDACS	Bank Account Webhook - Sample - BACS rejection codes - ARUCS
Bank Account Webhook - Sample - BACS rejection codes - ARUDD	Bank Account Webhook - Sample - BACS rejection codes - AUDDIS
Bank Account Webhook - Sample - BACS rejection codes - AWACS
Bank Account Webhook - Sample - Input Reports

Field	Sample Value
description	bank account disabled
enabled	false
bacs_reason_code	ADDACS2
bacs_description	payer deceased
bacs_reference	XYZ0012345-0012345
bacs_filename	Addacs020419111111

Field	Sample Value
description	SMP Service - Bank Account updated
bacs_reason_code	ADDACS3
bacs_description	instruction cancelled, account transferred
bacs_reference	XYZ0012345-0012345
bacs_filename	Addacs020419111111

Field	Sample Value
description	bank account is disabled
enabled	false
bacs_reason_code	INPUTC
bacs_description	destination sorting code and originating sorting code were invalid on the item
bacs_reference	2022080301S102184102
bacs_filename	ReftInput020822080046.xml

Bank Account Webhooks

Bank Account Webhook - Structure

Bank Account Webhook - Samples

Bank Account Webhook - Sample - API Actions

Bank Account Webhook - Sample - API Actions - Record Creation

Bank Account Webhook - Sample - BACS rejection codes - ADDACS

Bank Account Webhook - Sample - Rejection Report - ADDACS 2

Bank Account Webhook - Sample - Rejection Report - ADDACS 3

If new bank details have not been supplied

If new bank details have been supplied

Bank Account Webhook - Sample - Rejection Report - ADDACS B

Bank Account Webhook - Sample - Rejection Report - ADDACS C

Bank Account Webhook - Sample - Rejection Report - ADDACS E

Bank Account Webhook - Sample - BACS rejection codes - ARUCS

Bank Account Webhook - Sample - Rejection Report - ARUCS 0

Bank Account Webhook - Sample - Rejection Report - ARUCS 2

Bank Account Webhook - Sample - Rejection Report - ARUCS 3

Bank Account Webhook - Sample - Rejection Report - ARUCS 5

Bank Account Webhook - Sample - Rejection Report - ARUCS B

Bank Account Webhook - Sample - Rejection Report - ARUCS C

Bank Account Webhook - Sample - BACS rejection codes - ARUDD

Bank Account Webhook - Sample - Rejection Report - ARUDD 2

Bank Account Webhook - Sample - Rejection Report - ARUDD 3

If new bank details have not been supplied

If new bank details have been supplied

Bank Account Webhook - Sample - Rejection Report - ARUDD 5

Bank Account Webhook - Sample - Rejection Report - ARUDD B

Bank Account Webhook - Sample - BACS rejection codes - AUDDIS

Bank Account Webhook - Sample - Rejection Report - AUDDIS 2

Bank Account Webhook - Sample - Rejection Report - AUDDIS 3

If new bank details have not been supplied

If new bank details have been supplied

Bank Account Webhook - Sample - Rejection Report - AUDDIS 5

Bank Account Webhook - Sample - Rejection Report - AUDDIS B

Bank Account Webhook - Sample - Rejection Report - AUDDIS C

Bank Account Webhook - Sample - Rejection Report - AUDDIS F

Bank Account Webhook - Sample - Rejection Report - AUDDIS G

Bank Account Webhook - Sample - Rejection Report - AUDDIS K

Bank Account Webhook - Sample - Rejection Report - AUDDIS L

Bank Account Webhook - Sample - Rejection Report - AUDDIS N

Bank Account Webhook - Sample - BACS rejection codes - AWACS

Bank Account Webhook - Sample - Rejection Report - AWACS 0

Bank Account Webhook - Sample - Rejection Report - AWACS 3

Bank Account Webhook - Sample - Input Reports

Bank Account Webhook - Sample - Input Reports - INPUT C

Bank Account Webhook - Sample - Input Reports - INPUT D

Bank Account Webhook - Sample - Input Reports - INPUT E

Bank Account Webhook - Sample - Input Reports - INPUT F

Bank Account Webhook - Sample - Input Reports - INPUT G

Bank Account Webhook - Sample - Input Reports - INPUT H

Bank Account Webhook - Sample - Input Reports - INPUT I

Bank Account Webhook - Sample - Input Reports - INPUT J

Bank Account Webhook - Sample - Input Reports - INPUT K

Bank Account Webhook - Sample - Input Reports - INPUT L

Bank Account Webhook - Sample - Input Reports - INPUT M

Bank Account Webhook - Sample - Input Reports - INPUT O

Bank Account Webhook - Sample - Input Reports - INPUT P

Bank Account Webhook - Sample - Input Reports - INPUT T

Bank Account Webhook - Sample - Input Reports - INPUT U

Bank Account Webhook - Sample - Input Reports - INPUT X

Bank Account Webhook - Sample - Input Reports - INPUT Y

Bank Account Webhook - Sample - Input Reports - INPUT Z