Introduction

To start using the SmarterPay API you will require API credentials which can be found within the SmarterPay portal or from your SmarterPay representative, these credentials are then consumed as bearer tokens in each REST call.

SmarterPay API is based on a REST service using JSON transfer format.


Information in these sections will identify quick reference guides or code snippets

Getting Started

Your Authorisation Code, Bank Account Details and SUN (Service User Number) are stored in the SmarterPay Cloud Portal. Bank account details and your SUN are a matched pair identified at bacs and are linked by your authorisation code within the SmarterPay system. Each payment(debit) and/or credit is taken or paid to to your bank account which to the linked bank account and sun.

Currently this solution supports a single SUN only per client authorisation code.

Payments and recurrence schedules are collected and setup against a "Bank account mandate", this process follows one of two routes as shown below

One Off Payments Recurrence Schedule – payment will happen automatically, defined within the Recurrence Schedule
Create a "Customer Account" (Optional) Create a "Customer Account" (Optional)
Modulus Check account details to be used below Modulus Check account details to be used below
Create a "Bank Account" Create a "Bank Account"
Create a "Mandate" Create a "Mandate"
Create a single "Payment" Create a "Recurrence Schedule"

Email Notifications

Email templates will be configured to reflect your template and colour schemes, at various points emails can be triggered with the SmarterPay Cloud system. Providing a customer account is supplied and this functionality is enabled emails will be sent to the email address specified on the customer account.

There is no current requirement to send a notice for credits.

If there is a SMTP error on sending an email to the customer, webhooks will be sent as notifications of these events.







Email template Description
DD Setup Confirmation Sent when a new "Mandate" is setup.
Advanced Notification Of Recurrence Schedule Sent when a new "Recurrence Schedule" is setup. This email will describe the regular repeat payments, showing the amount and day of collection.
Advanced Notification Of Payment Sent when a new "Payment" is setup. This email will describe the single payment details, showing the amount and date of collection
Advanced Notification Of Represent Sent when a new "Payment" (specifically a represent) is setup. This email will describe the original and new amount including date of collection

Endpoints

The API and webhook enpoints are only available over HTTPS, attempting to access the API or using attempting to use webhooks over an unsecured HTTP connection will return a TLS_Required error.

API webhooks are found within the SmarterPay Cloud portal or from your SmarterPay representative whereas webhook endpoints are supplied to SmarterPay by the client and can be changed within the SmarterPay Cloud Portal.

If you continue to still have issues with endpoints please contact us either by telephone on +44 (0)1482 240886 or by email at support@smarterpay.com







Response Codes

Each API request will result in a response code and response text.
You may encounter the following response codes. Any unsuccessful response codes will contain more information to help you identify the cause of the problem

200 OK should be the standard response for a successful API request.

The table on the right is a reference link to other error codes that may require investigation.
List Of Response Codes

If you continue to still have issues with error codes please contact us either by telephone on +44 (0)1482 240886 or by email at support@smarterpay.com







REST URLs

The following REST urls are available to connect to within the SmarterPay Cloud API. Your instance url will be supplied to you by your SmarterPay representative.

{id} denotes an record ID.
All requests and responses are JSON-formatted and UTF-8 encoded. Providing the Accept header is optional, but recommended.The Content-Type header must be provided when sending data to the API (using POST and PUT endpoints) passing either the standard JSON MIME type (application/json), or the JSON-API variant (application/vnd.api+json).

Rest Service Rest Service URL
CustomerAccount Instance_url/CustomerAccount
ModulusCheck Instance_url/ModulusCheck
BankAccount Instance_url/BankAccount
Mandate Instance_url/Mandate
RecurrenceSchedule Instance_url/RecurrenceSchedule
Payment Instance_url/Payment
Represent Instance_url/Payment/{id}/Represent
Credit Instance_url/Credit
Client Bank Accounts Instance_url/Clientbankaccount
Service User Number Instance_url/ServiceUserNumber

REST Commands

Customer Account


Customer Account records hold the contact details for a customer. A customer can have several customer bank accounts, which in turn can have several Direct Debit mandate setup, payments taken or refunds setup.

{id} donates the id of the record.

All timestamps are formatted as ISO8601 with timezone information. For API calls that allow for a timestamp to be specified, we use that exact timestamp. These timestamps look something like 2014-02-27T15:05:06.123Z.For endpoints that require dates, we expect a date string of the format YYYY-MM-DD, where an example would look like 2014-02-27.

Method Purpose
POST Create Customer Account - Instance_url/CustomerAccount
PUT Update Customer Account - Instance_url/CustomerAccount/{id}
GET Return Customer Account - Instance_url/CustomerAccount/{id}

REST Commands

POST Customer Account


Request Parameters
Property Mandatory Description
email True Max 100 Chars - must be valid email
first_name True Max 50 chars
last_name True Max 50 chars
address_line1 True Max 50 chars
city True Max 50 chars
postal_code True Max 50 chars
address_line2 False Max 50 chars
title False Max 50 chars
company_name False Max 50 chars
country_code False Max 50 chars, if empty defaults to "GB"

Response Parameters
Property Description
id Unique identifier beginning with specified prefix followed by 8 digit auto number
address_line1 First line of address
address_line2 Second line of address
city Returns city
company_name Returns company name
email Returns email
first_name Returns first name
last_name Returns last name
postal_code Returns postal code
country_code Returns country code
status Returns the status of the customer account
created_at Datetime formatted as ISO8601


Instance URL

Instance_url/CustomerAccount

Request Sample


{
 "Customer_Account":
  {
   "email":"test@test.com",
   "company_name":"testcompany",
   "title":"Mr",
   "first_name":"test",
   "last_name":"test",
   "address_line1":"74 test street",
   "address_line2":"test line 2",
   "city":"testcity",
   "postal_code":"Q1 TEST",
   "country_code":"GB"
  }
}

Response Sample


{
 "Customer_Account":
   {
     "id":"CUST000012345",
     "created_at":"2018-08-23T17:01:06.000Z",
     "email":"test@test.com",
     "company_name":"testcompany",
     "title":"Mr",
     "first_name":"test",
     "last_name":"test",
     "address_line1":"74 test street",
     "address_line2":"test line 2",
     "city":"testcity",
     "postal_code":"Q1 TEST",
     "country_code":"GB",
     "status":"active"
   }
}

REST Commands

PUT Customer Account


Request Parameters

Property Mandatory Description
email True Max 100 Chars - must be valid email
first_name True Max 50 chars
last_name True Max 50 chars
address_line1 True Max 50 chars
city True Max 50 chars
postal_code True Max 50 chars
address_line2 False Max 50 chars
title False Max 50 chars
company_name False Max 50 chars
country_code False Max 50 chars

Response Parameters

Property Description
id Unique identifier beginning with specified prefix followed by 8 digit auto number
address_line1 First line of address
address_line2 Second line of address
city Returns city
company_name Returns company name
email Returns email
first_name Returns first name
last_name Returns last name
postal_code Returns postal code
country_code Returns country code
status Returns the status of the customer account
created_at Datetime formatted as ISO8601

Instance URL

Instance_url/CustomerAccount/{id}

Request Sample


{
 "Customer_Account":
  {
   "email":"test@test.com",
   "company_name":"testcompany",
   "title":"Mr",
   "first_name":"test",
   "last_name":"test",
   "address_line1":"74 test street",
   "address_line2":"test line 2",
   "city":"testcity",
   "postal_code":"Q1 TEST",
   "country_code":"GB"
  }
}

Response Sample


{
 "Customer_Account":
   {
     "id":"CUST000012345",
     "created_at":"2018-08-23T17:01:06.000Z",
     "email":"test@test.com",
     "company_name":"testcompany",
     "title":"Mr",
     "first_name":"test",
     "last_name":"test",
     "address_line1":"74 test street",
     "address_line2":"test line 2",
     "city":"testcity",
     "postal_code":"Q1 TEST",
     "country_code":"GB",
     "status":"active"
   }
}

REST Commands

GET Customer Account



Response Parameters
Property Description
id Unique identifier beginning with specified prefix followed by 8 digit auto number
address_line1 First line of address
address_line2 Second line of address
city Returns city
company_name Returns company name
email Returns email
first_name Returns first name
last_name Returns last name
postal_code Returns postal code
country_code Returns country code
status Returns the status of the customer account
created_at Datetime formatted as ISO8601

Request Sample


Instance_url/CustomerAccount/CUST000012345


Response Sample


{
 "Customer_Account":
   {
     "id":"CUST000012345",
     "created_at":"2018-08-23T17:01:06.000Z",
     "email":"test@test.com",
     "company_name":"testcompany",
     "title":"Mr",
     "first_name":"test",
     "last_name":"test",
     "address_line1":"74 test street",
     "address_line2":"test line 2",
     "city":"testcity",
     "postal_code":"Q1 TEST",
     "country_code":"GB",
     "status":"active"
   }
}

REST Commands

Modulus Check Overview


This service allows to check the validity of a account number and sortcode, returning various details about the account

Method Purpose
POST Modulus Check Account Details - Instance_url/ModulusCheck

REST Commands

Modulus Check POST


Request Parameters


Property Mandatory Description
account_number True Must be 8 numbers with leading zeros, no spaces or hyphens
sort_code True Must be 6 numbers with leading zeros, no spaces or hyphens

Response Parameters


Property Description
AccountCodeOK Returns true if account number entered is valid
account_number Supplied account number
bank_address1 Address line one for bank
bank_address2 Address line two for bank
bank_address3 Address line three for bank
bank_address4 Address line four for bank
bank_addressPostCode Postal code for bank
bank_name Name of bank
credits_allowed Returns true if credits are setup with bank
direct_debit_instruction_ok Returns true if direct debit instruction is ok
direct_debits Returns true if direct debits are available
sort_code Supplied sort code
sort_code_ok Returns true if sort code is valid
Telephone Returns telephone number
Error Returns error code if any

Instance URL

Instance_url/ModulusCheck


Request Sample


{
 "Modulus_Check":
  {
   "account_number":"12345678",
   "sort_code":"123456"
  }
}


Response Sample


{
 "Modulus_Check":
  {
   "AccountCodeOK":true,
   "account_number":"12345678",
   "bank_address1":"bank street",
   "bank_address2":"",
   "bank_address3":"",
   "bank_address4":"Liverpool",
   "bank_addressPostCode":"L1 TEST",
   "bank_name":"Santander UK plc",
   "branch_title":"bankAccount One",
   "credits_allowed":true,
   "direct_debit_instruction_ok":true,
   "direct_debits":true,
   "sort_code":"123456",
   "sort_code_ok":true,
   "Telephone":"012345678",
   "Error":""
  }
}

REST Commands

Bank Account Overview


Bank Account records hold the bank details of a customer.

These records may be linked to a customer account record and may also be linked to several Direct Debit Mandates. SmarterPay will notify you via a webhook whenever the state of a bank account record changes
Method Purpose
POST Create Bank Account - Instance_url/BankAccount
DELETE DELETE Bank Account - Instance_url/BankAccount/{id}
GET GET Bank Account - Instance_url/BankAccount/{id}
{id} denotes ID of record

REST Commands

Bank Account POST


Request Parameters


Property Mandatory Description
account_number True Must be 8 numbers with leading zeros, no spaces or hyphens
sort_code True Must be 6 numbers with leading zeros, no spaces or hyphens
account_name True Name of the account holder as known by the bank. This usually matches the name of the linked customer. This field will be transliterated, upcased and truncated to 18 characters.
customer_account false Must be a valid customer account id or left blank.

Response Parameters


Property Description
id Unique identifier beginning with assigned prefix followed by an autonumber
created_at Datetime formatted as ISO8601
account_number Bank account account number
sort_code Bank account sort code
enabled True if an active account
bank_name Name of the bank
customer_account Linked customer account


Instance URL

Instance_url/BankAccount


Request Sample


{
 "bank_account":
  {
   "account_number":"12345678",
   "sort_code":"123456",
   "account_name":"Test Name",
   "customer_account":"CUST00002352"
  }
}

Response Sample


{
 "bank_account":
  {
   "id":"BANK00003454",
   "created_at":"2018-08-23T12:43:17.000Z",
   "account_number":"12345678",
   "sort_code":"123456",
   "account_name":"Test Name",
   "enabled":true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST00002352"
  }
}

REST Commands

Bank Account DELETE


Response Parameters


Property Description
id Unique identifier beginning with assigned prefix followed by an autonumber
created_at Datetime formatted as ISO8601
account_number Bank account account number
sort_code Bank account sort code
enabled True if an active account
bank_name Name of the bank
customer_account Linked customer account

Request Sample


DELETE Instance_url/BankAccount/{id}

{id} denotes a bank account ID

Response Sample


{
 "bank_account":
  {
   "id":"BANK00003454",
   "account_name":"Test Name",
   "account_number":"12345678",
   "bank_name":"BARCLAYS BANK PLC",
   "created_at":"2018-08-23T12:43:17.000Z",
   "customer_account":"CUST00002352",
   "enabled":false,
   "sort_code":"123456"
  }
}

REST Commands

Bank Account GET


Response Parameters


Property Description
id Unique identifier beginning with assigned prefix followed by an autonumber
created_at Datetime formatted as ISO8601
account_number Bank account account number
sort_code Bank account sort code
enabled True if an active account
bank_name Name of the bank
customer_account Linked customer account

Request Sample


GET Instance_url/BankAccount/{id}

{id} denotes a bank account ID

Response Sample


{
 "bank_account":
  {
   "id":"BANK00003454",
   "created_at":"2018-08-23T12:43:17.000Z",
   "account_number":"12345678",
   "sort_code":"123456",
   "account_name":"Test Name",
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST00002352",
   "enabled":false
  }
}

REST Commands

Mandate Overview


Mandate represent the Direct Debit mandate with a customer. SmarterPay will notify you via a webhook whenever the state of a Mandate changes.

If a Mandate is cancelled any payments, or credits, currently set to “pending_submission” will be updated and set to “cancelled” with a zero amount, and update notifications will be sent via payment or credit Webhooks. For example, if the mandate AUD0012345678 is set to cancelled and two payments are still to be collected, the reply will detail the Cancelled Mandate, and two Payment Webhooks will be sent, one for each payments.
On a cancellation of a mandate any recurring schedules attached to the mandate will also be made inactive with notification by webhook.

Inserting mandates will now reference a client bank account. This can be optional on insert or can be specified, however if it is blank on insert it will set the default bank account attached to the default sun for the client.

It is not possible to create a mandate with a non enabled bank account, this will return a bad request error.

Method Purpose
POST Create Mandate - Instance_url/Mandate
PUT Update Mandate - Instance_url/Mandate/{id}
GET Return Mandate - Instance_url/Mandate/{id}

{id} denotes ID of record

REST Commands

Mandate POST


Request Parameters


Property Mandatory Description
customer_bank_account True ID Of a customer bank account
auddis false The unique AUDDIS ref beginning with the assigned prefix followed by an auto number. if no reference is provided to use then one will be generated.
client_bank_account_id false The client bank account the mandate will be registered to, if blank or not supplied it will default to the default bank account on the default sun

Response Parameters


Property Description
Sun_name Friendly name attached to a sun
Sun_Number Sun that is attached to this mandate
account_name Name on the account
account_number Account number supplied from bank account record
auddis Unique identifier
client_bank_account_id Uniquer Idenifier for the attached client bank account
created_at Datetime formatted as ISO8601
bank_name Name of the bank
customer_account Customer account ID if one has been created
customer_bank_account Customer bank account ID
dd_status Status of the direct debit created. Can be set to either : "new instruction", "first collection","ongoing collection","cancelled","cancelled by payer" or "cancelled by originator"
sort_code Sort code supplied from bank account record
originator_account_number Originator account number that the mandate is connected to
originator_sort_code Orginator sort code that the mandate is connected to

Instance URL

Instance_url/Mandate


Request Sample



{
 "Mandate":
  {
   "customer_bank_account":"BANK00003432",
   "auddis":"AUD00003343",
   "client_bank_account_id":"CBA-000001"
  }
}


Response Sample



{
 "Mandate":
  {
   "Sun_Name" : "Sun1",
   "Sun_Number":"123",
   "auddis":"AUD00003343",
   "created_at":"2018-08-23T12:43:18.000Z",
   "account_number":"12345678",
   "sort_code":"123456",
   "account_name":"Test Name",
   "bank_name":"BARCLAYS BANK PLC",
   "client_bank_account_id": "CBA-0000001",
   "customer_bank_account":"BANK00003432",
   "customer_account":"CUST00002424",
   "dd_status":"new instruction",
   "originator_account_number":"1104102",
   "originator_sort_code":"077456"   }
}

REST Commands

Mandate PUT


Request Parameters


Property Mandatory Description
auddis True Auddis ID of the mandate
dd_status True Status of the mandate. Can be set to either : "new instruction", "first collection","ongoing collection" or "cancelled".

Response Parameters


Property Description
Sun_name Friendly name attached to a sun
Sun_Number Sun that is attached to this mandate
account_name Name on the account
account_number Account number supplied from bank account record
auddis Unique identifier
client_bank_account_id Uniquer Idenifier for the attached client bank account
created_at Datetime formatted as ISO8601
bank_name Name of the bank
customer_account Customer account ID if one has been created
customer_bank_account Customer bank account ID
dd_status Status of the direct debit created. Can be set to either : "new instruction", "first collection","ongoing collection" or "cancelled""
sort_code Sort code supplied from bank account record
originator_account_number Originator account number that this mandate is registered to
originator_sort_code Originator sort code that this mandate is registered to

Request Sample



{
 "Mandate":
  {
   "auddis":"AUD00003343",
   "dd_status":"cancelled"
  }
}


Response Sample



Response Sample



{
 "Mandate":
  {
   "Sun_Name" : "Sun1",
   "Sun_Number":"123",
   "auddis":"AUD00003343",
   "created_at":"2018-08-23T12:43:18.000Z",
   "account_number":"12345678",
   "sort_code":"123456",
   "account_name":"Test Name",
   "bank_name":"BARCLAYS BANK PLC",
   "client_bank_account_id": "CBA-0000001",
   "customer_bank_account":"BANK00003432",
   "customer_account":"CUST00002424",
   "dd_status":"new instruction",
   "originator_account_number":"11104102",
   "originator_sort_code":"077456"
  }
}

REST Commands

Mandate GET



Response Parameters


Property Description
auddis Unique identifier
created_at Datetime formatted as ISO8601
account_number Account number supplied from bank account record
sort_code Sort code supplied from bank account record
account_name Name on the account
bank_name Name of the bank
customer_account Customer account ID if one has been created
customer_bank_account Customer bank account ID
dd_status Status of the direct debit created. Can be set to either : "new instruction", "first collection","ongoing collection","cancelled","cancelled by payer" or "cancelled by originator"
originator_account_number Originator account number this mandate is registered to
originator_sort_code Originator sort code this mandate is registered to

Request Sample


GET Instance_url/Mandate/{ID}

{ID} denotes field for mandate record ID

Response Sample



{
 "Mandate":
  {
    "Sun_Name": "tes1",
   "Sun_Number": "122",
   "account_name": "Test Name",
    "account_number": "11104102",
    "auddis": "AUD00003343",
    "bank_name": "NATIONWIDE BUILDING SOCIETY",
    "client_bank_account_id": "CBA-0000001",
    "created_at": "2019-03-19T14:14:48Z",
    "customer_account": "BGB2BCUST00017050",
    "customer_bank_account": "BGB2BACC00010169",
   "dd_status": "first collection",
    "sort_code": "074456",
   "originator_account_number":"11104102",
   "originator_sort_code":"077456"
  }
}

REST Commands

Recurrence Schedule Overview


Recurrence Schedules create payments according to a Schedule, and automated payments are collected against a Bank Account Mandate. A Payment must happen at least every 12 months; the Direct debit is cancelled at 13 months by the paying bank. SmarterPay will notify you via a webhook whenever the state of a Recurrence Schedule changes.

Please note that in the event of a mandate being cancelled either by a requested change or a BACS report change, any recurrence schedules will be cancelled along with any unsubmitted payments attached to the mandate.

Method Purpose
POST Create Recurrence Schedule - Instance_url/RecurrenceSchedule
DELETE Delete Recurrence Schedule - Instance_url/RecurrenceSchedule/{id}
GET Return Recurrence Schedule - Instance_url/RecurrenceSchedule/{id}
{id} denotes ID of record

REST Commands

Recurrence Schedule POST


Request Parameters


Property Mandatory Description
auddis True Unique auddis identifier
amount True Amount in pence – no decimal point
description True description of the recurrence schedule
collection_period True Can be set to either monthly or weekly
collection_stretch True This is the collection stretch of the period, for example setting the field "1" would be every cycle of the collection_period
collection_day True Set to either "1" – "28" or "last day", this is not required on weekly collections
start_date True 10 digit start date in the format of "YYYY-MM-DD"
end_date False 10 digit date, will be ignored if left blank or null
status False Should always show as "active", the only other value would be "inactive"
first_collection_amount True First Collection Amount

Response Parameters


Property Description
auddis Unique auddis identifier
id Unique identifier
amount Amount
description Reference description – will be included in outgoing email if enabled
collection_period Can be set to either monthly or weekly
collection_day Set to either "1" - "28" or "last day"
collection_stretch Stretch of collection period
start_date 10 digit start date in the format of "YYYY-MM-DD"
end_date 10 digit date
status Returns "active" or "inactive"
created_at Datetime formatted as ISO8601
first_collection_amount Amount that will be taken for the first collection
first_collection_date When the first collection will be attempted
next_collection_date Next collection date
upcoming_payments JSON formatted collections

Instance URL

Instance_url/RecurrenceSchedule


Request Sample



{
 "recurrence_schedule":
  {
   "amount":2500,
   "description":"Monthly Subscription",
   "collection_period":"monthly",
   "collection_day":"1",
   "collection_stretch":"1",
   "auddis":"AUD00003435",
   "start_date":"2018-09-01",
   "end_date":null,
    "first_collection_amount": 4500,
    "status": "active"
  }
}


Response Sample



{
 "recurrence_schedule":
  {
   "amount":"2500",
   "auddis":"AUD00003435",
   "collection_stretch":"1",
   "collection_day":"1"
   "id":"RD00002323",
   "created_at":"2018-08-23T12:43:18.000Z",
   "status":"active",
   "description":"Monthly Subscription",
   "start_date":"2018-09-01",
   "end_date":null,
   "collection_period":"monthly",
   "first_collection_amount": "4500",
   "first_collection_date": "2018-10-01",
   "next_collection_date": "2019-12-12",
   "upcoming_payments": "[{ \"collection_date\": \"2019-12-12\", \"amount\": 200 },{ \"collection_date\": \"2020-01-31\",,
    \"amount\": 300 } { \"collection_date\": \"2020-03-02\", \"amount\": 300 },{ \"collection_date\": \"2020-03-31\", \"amount\": 300 },{,
    \"collection_date\": \"2020-04-30\", \"amount\": 300 },{ \"collection_date\": \"2020-06-01\", \"amount\": 300 }]"
  }
}

REST Commands

Recurrence Schedule DELETE


Response Parameters


Property Description
auddis Unique auddis identifier
id Unique identifier
created_at Datetime formatted as ISO8601
status Returns status


Request Sample


DELETE Instance_url/RecurrenceSchedule/{id}

{id} denotes record ID

Response Sample



{
 "recurrence_schedule":
  {
   "auddis":"AUD00003435",
   "id":"RD00002323",
   "created_at":"2018-08-23T12:43:18.000Z",
   "status":"inactive"
  }
}

REST Commands

Recurrence Schedule GET


Response Parameters


Property Description
auddis Unique auddis identifier
id Unique identifier
amount Amount
description Reference description – will be included in outgoing email
collection_period Can be set to either monthly or weekly
collection_stretch Stretch of collection period
collection_day Set to either "1" - "28" or "last day"
start_date 10 digit start date in the format of "YYYY-MM-DD"
end_date 10 digit date
status Returns "active" or "inactive"
created_at Datetime formatted as ISO8601
first_collection_amount Amount that will be taken for the first collection
first_collection_date When the first collection will be attempted
next_collection_date Next collection date
upcoming_payments JSON formatted collections

Request Sample


GET Instance_url/RecurrenceSchedule/{id}
{id} denotes record ID

Response Sample



{
 "recurrence_schedule":
  {
   "amount":"2500",
   "auddis":"AUD00003435",
   "collection_stretch":"1",
   "collection_day":"1"
   "id":"RD00002323",
   "created_at":"2018-08-23T12:43:18.000Z",
   "status":"active",
   "description":"Monthly Subscription",
   "start_date":"2018-09-01",
   "end_date":null,
   "collection_period":"monthly",
   "first_collection_amount": "4500",
   "first_collection_date": "2018-10-01",
   "next_collection_date": "2019-12-12",
   "upcoming_payments": "[{ \"collection_date\": \"2019-12-12\", \"amount\": 200 },{ \"collection_date\": \"2020-01-31\",,
    \"amount\": 300 } { \"collection_date\": \"2020-03-02\", \"amount\": 300 },{ \"collection_date\": \"2020-03-31\", \"amount\": 300 },{,
    \"collection_date\": \"2020-04-30\", \"amount\": 300 },{ \"collection_date\": \"2020-06-01\", \"amount\": 300 }]"
  }
}

REST Commands

Payment Overview


Payments can only be setup against active Mandate, the dd_status values must be "new_instructions", "first_collection", "ongoing_collection" or "final_collection", if the dd_status is set to "cancelled", "cancelled by payer" or "cancelled by originator", then a Payment cannot be setup.Records with a "payment_type" set to "first_collection", "ongoing_collection" or "final_collection" are all standard payment records, "payment_type" set to "represent" are those that are sent after an initial payment was returned unpaid, these payments will also have "related_payment" set to the "id" of the previously failed payment.

Payment against Cancelled Mandates
If the SmarterPay Payment Service receives a Payment POST message and the Mandate dd_status is set to "cancelled", "cancelled by payer" or "cancelled by originator", then the payment will be recorded as cancelled with a zero amount. For example the following payment request is being made against Mandate AUD0012345678, and the dd_status of that mandate is set to "cancelled by payer", the returned amount and status is 0 and cancelled.

Invalid Payment dates
If the DDMS Payment Service receives a Payment POST message with collection_date set to before today, then a 400 BAD REQUEST will be returned. If the SmarterPay Payment Service receives a Payment POST message with collection_date set to a none banking date (weekend or national bank holiday), or is not 3 clear banking days into the future, the SmarterPay DDMS service will record/store the Payment record with next available banking day (that it can be collected – mindful of 3 banking days), and return this date in the response. For example the following POST request, sets the “collection_date” to Friday 30th March (this is the Easter Bank Holiday weekend), and both Friday 30th and Monday 2nd are national bank holidays, and the so the date stored and returned is Tuesday 3rd April.

Updating payments
If the SmarterPay DDMS Payment Service receives a Payment PUT message to cancel a Payment, and the payment has already set to "submitted", "successful" or indeed "failed", then the service will reply with existing status of the Payment. For example, if PUT request, sets the amount to 0, and the specific Payment has already been submitted, the status in the response will submitted and the amount will be as is, The SmarterPay portal will record that the request was attempted.

Method Purpose
POST Create Payment - Instance_url/Payment
PUT Update Payment - Instance_url/Payment/{id}
GET Return Payment - Instance_url/Payment/{id}
{id} denotes ID of record

REST Commands

Payment POST


Request Parameters


Property Mandatory Description
auddis True The unique AUDDIS reference.
amount True Amount in pence – no decimal point
description True Reference description – will be included in outgoing email
collection_date True Date to receive payment - 10 digit date in the format of “YYYY-MM-DD”

Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
collection_date Date to receive payment - 10 digit date in the format of "YYYY-MM-DD", corrected, if the date received by the service is a none banking day, weekend or national bank holiday "
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"
payment_type Can be set to either "first_collection", "ongoing_collection","final_collection" or "represent"
related_payment This is the Payment id of the initial Failed Payment, only applicable for represented payments

Instance URL

Instance_url/Payment


Request Sample



{
 "payment":
  {
   "amount":100,
   "collection_date":"2018-08-25",
   "description":"metered bill",
   "auddis":"AUD00003435"
  }
}


Response Sample


{
 "payment":
  {
   "id":"RD00002323",
   "created_at":"2018-08-23T12:43:18.000Z",
   "collection_date":"2018-08-25",
   "amount":100,
   "payment_type":"ongoing_collection",
   "description":"metered bill",
   "status":"pending_submission",
   "auddis":"AUD00003435",
   "related_payment":""
  }
}

REST Commands

Payment PUT


Request Parameters


Property Mandatory Description
auddis True The unique AUDDIS reference.
amount True Amount in pence – no decimal point
description True Reference description – will be included in outgoing email
collection_date True Date to receive payment - 10 digit date in the format of “YYYY-MM-DD”

Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
collection_date Date to receive payment - 10 digit date in the format of "YYYY-MM-DD", corrected, if the date received by the service is a none banking day, weekend or national bank holiday "
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"
payment_type Can be set to either "first_collection", "ongoing_collection","final_collection" or "represent"
related_payment This is the Payment id of the initial Failed Payment, only applicable for represented payments

Instance URL

Instance_url/Payment/{id}



Request Sample



{
 "payment":
  {
   "amount":100,
   "collection_date":"2018-08-25",
   "description":"metered bill",
   "auddis":"AUD00003435",
   "original_payment_id":"PAY00003432",
  }
}


Response Sample



{
 "payment":
  {
   "id":"PAY00003432",
   "created_at":"2018-08-23T12:43:18.000Z",
   "collection_date":"2018-08-25",
   "amount":100,
   "payment_type":"ongoing_collection",
   "description":"metered bill",
   "status":"pending_submission",
   "auddis":"AUD00003435",
   "related_payment":""
  }
}

REST Commands

Payment GET


Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
collection_date Date to receive payment - 10 digit date in the format of "YYYY-MM-DD", corrected, if the date received by the service is a none banking day, weekend or national bank holiday "
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"
payment_type Can be set to either "first_collection", "ongoing_collection","final_collection" or "represent"
related_payment This is the Payment id of the initial Failed Payment, only applicable for represented payments

Request Sample


GET Instance_url/Payment/{id}

{id} denotes payment id reference

Response Sample



{
 "payment":
  {
   "id":"PAY00003432",
   "created_at":"2018-08-23T12:43:18.000Z",
   "collection_date":"2018-08-25",
   "amount":100,
   "payment_type":"ongoing_collection",
   "description":"metered bill",
   "status":"pending_submission",
   "auddis":"AUD00003435",
   "related_payment":""
  }
}

REST Commands

Represent Overview


Returned Unpaid Payments, can be Represented, BACS rules govern how and when these payments can be Represented. Represents records represent a single payment retry from a customer, taken against an existing Unpaid Payments record and therefore require a reference to the original payment.

SmarterPay will notify you via a webhook whenever the state of a Represented payment changes.

If the SmarterPay DDMS Payment Service receives a Represent Payment message with collection_date set to a none banking date (weekend or national bank holiday), the SmarterPay DDMS service will record/store the Payment record with next available banking day, and return this date in the response. For example the following POST request, sets the “collection_date” to Friday 30th March (this is the Easter Bank Holiday weekend), and both Friday 30th and Monday 2nd are national bank holidays, and the so the date stored and returned is Tuesday 3rd April.


Method Purpose
POST Create Payment - Instance_url/Payment/{id}/Represent
PUT Update Payment - Instance_url/Payment/{id} ( Refer to this section )
GET Return Payment - Instance_url/Payment/{id} ( Refer to this section )
{id} denotes ID of record

REST Commands

Represent POST


Request Parameters


Property Mandatory Description
auddis True The unique AUDDIS ref beginning with the assigned prefix followed by an auto number. if no reference is provided to use then one will be generated.
amount True Amount in pence – no decimal point
description True Reference description – will be included in outgoing email
collection_date True Date to receive payment - 10 digit date in the format of “YYYY-MM-DD”

Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
collection_date Date to receive payment - 10 digit date in the format of "YYYY-MM-DD", corrected, if the date received by the service is a none banking day, weekend or national bank holiday "
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"
payment_type Can be set to either "first_collection", "ongoing_collection","final_collection" or "represent"
related_payment This is the Payment id of the initial Failed Payment, only applicable for represented payments

Instance URL

Instance_url/Payment/{id}/Represent

Request Sample



{
 "payment":
  {
   "amount":100,
   "collection_date":"2018-08-25",
   "description":"metered bill",
   "auddis":"AUD00003435"
  }
}


Response Sample



{
 "payment":
  {
   "id":"PAY0000031",
   "created_at":"2018-08-23T12:43:18.000Z",
   "collection_date":"2018-08-25",
   "amount":100,
   "payment_type":"ongoing_collection",
   "description":"metered bill",
   "status":"pending_submission",
   "auddis":"AUD00003435",
   "related_payment":"PAY00000034"
  }
}

REST Commands

Credit Overview


Credit records represent a BACS Credit, this is not a refund against any one Direct Debit collection. Credits can be used for Bill payments, payroll or indeed to make a genuine refund.

If the DDMS Credit Service receives a Credit message with credit_date set to a none banking date (weekend or national bank holiday), the DDMS service will record/store the Payment record with next available banking day, and return this date in the response. For example the following POST request, sets the “credit_date” to Friday 30th March (this is the Easter Bank Holiday weekend), and both Friday 30th and Monday 2nd are national bank holidays, and the so the date stored and returned is Tuesday 3rd April.

When creating a credit you must supply an AUDDIS ID or a Client Bank Account ID, if neither is supplied the default SUN and default Client Bank Account for your client will be attached to the credit

Method Purpose
POST Create Credit - Instance_url/Credit
PUT Update Credit - Instance_url/Credit/{id}
GET Return Credit - Instance_url/Credit/{id}

{id} denotes ID of record

REST Commands

Credit POST


Request Parameters


Property Mandatory Description
auddis See Notes The unique AUDDIS ref.
client_bank_account_id See Notes The unique reference for the client bank account
amount True Amount in pence – no decimal point
description True Reference description – will be included in outgoing email
credit_date True Date to receive payment - 10 digit date in the format of "YYYY-MM-DD"
reference True Credit reference
bank_account See Notes This is the customers bank account record, this is mandatory if no auddis is supplied

Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
Credit_date Date to send payment - 10 digit date in the format of "YYYY-MM-DD"
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"

Instance URL

Instance_url/Credit


Request Sample



{
 "credit":
  {
   "amount":100,
   "credit_date":"2018-08-25",
   "reference":"manual refund",
   "description":"metered bill",
   "auddis":"AUD00003435",
   "client_bank_account_id":"CBA-0000003",
   "bank_account":"CBA-0000003"
  }
}


Response Sample


{
 "credit": {
  "ID": "BGB2BCR00004151",
  "Sun_Name": "tes1",
  "Sun_Number": "122",
   "amount": "100",
   "auddis": "BGB2BAUD00003206",
   "bank_account": "BGB2BACC00003100",
   "client_bank_account_id": "CBA-0000003",
   "created_at": "2019-03-19T10:22:48Z",
   "credit_date": "2019-08-26",
   "description": "metered bill",
   "reference": "manual refund",
   "status": "pending_submission"
  }
}

REST Commands

Credit PUT


Request Parameters


Property Mandatory Description
amount True Amount in pence – no decimal point
description True Reference description – will be included in outgoing email
credit_date True Date to receive payment - 10 digit date in the format of "YYYY-MM-DD"
reference False Credit reference
status False This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"

Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
Credit_date Date to send payment - 10 digit date in the format of "YYYY-MM-DD"
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"

Instance URL

Instance_url/Credit/{id}
{id} denotes record id

Request Sample



{
 "credit":
  {
   "amount":100,
   "credit_date":"2018-08-25",
   "reference":"manual refund",
   "description":"metered bill",
   "status":"cancelled"
  }
}


Response Sample


{
 "credit": {
  "ID": "BGB2BCR00004151",
  "Sun_Name": "tes1",
  "Sun_Number": "122",
   "amount": "100",
   "auddis": "BGB2BAUD00003206",
   "bank_account": "BGB2BACC00003100",
   "client_bank_account_id": "CBA-0000003",
   "created_at": "2019-03-19T10:22:48Z",
   "credit_date": "2019-08-26",
   "description": "metered bill",
   "reference": "manual refund",
   "status": "pending_submission"
  }
}

REST Commands

Credit GET


Response Parameters


Property Description
id Unique identifier
auddis Unique auddis identifier
amount Amount
description Reference description – will be included in outgoing email
Credit_date Date to send payment - 10 digit date in the format of "YYYY-MM-DD"
created_at Datetime formatted as ISO8601
status This should always start with "pending_submission" and then change to "submitted", can also be "failed","successful" or "cancelled"

Instance URL

Instance_url/Credit/{id>
{id} denotes record id

Response Sample


{
 "credit": {
  "ID": "BGB2BCR00004151",
  "Sun_Name": "tes1",
  "Sun_Number": "122",
   "amount": "100",
   "auddis": "BGB2BAUD00003206",
   "bank_account": "BGB2BACC00003100",
   "client_bank_account_id": "CBA-0000003",
   "created_at": "2019-03-19T10:22:48Z",
   "credit_date": "2019-08-26",
   "description": "metered bill",
   "reference": "manual refund",
   "status": "pending_submission"
  }
}

REST Commands

Client Bank Account Overview


Client bank account records are where the client owners bank account records are stored. These are the bank account records that are lodged against a service user number or SUN.


Method Purpose
GET Get list of all client bank account records - Instance_url/clientbankaccount
GET Get a single client bank account record - Instance_url/clientbankaccount/{id}
GET Get the default client bank account via a sun number - Instance_url/clientbankaccount/sun/{id}
{id} denotes ID of record

REST Commands

Client Bank Account GET


Response Parameters


Property Description
Account_Number Masked account number
Bank_Name Bank name that the account is registered to
Default_Account Boolean value, if true this is the default account that is registered to the service user number ( SUN )
Friendly_Name Friendly name of the client bank account record, this is to aid in identifying accounts
ID Unique reference for this client bank account record
Sort_Code Masked sort code of this client bank account record
SUN Service User Number that this client bank account is attached to
Sun_Friendly_Name A friendly name that is attached to this sun, this is to aid in identifying accounts

Instance URL

Instance_url/clientbankaccount/{id}
{id} denotes record id

Response Sample


{
 "Client_Bank_Accounts":
  {
   "Account_Number": "*****102",
   "Bank_Name": "Natwest",
   "Default_Account": false,
   "Friendly_Name": "Test SUn 1",
   "ID": "CBA-0000001",
   "Sort_Code": "****56",
   "Sun": "122",
   "Sun_Friendly_Name": "tes1"
  }
}

REST Commands

Client Bank Account List GET


Response Parameters


Property Description
Account_Number Masked account number
Bank_Name Bank name that the account is registered to
Default_Account Boolean value, if true this is the default account that is registered to the service user number ( SUN )
Friendly_Name Friendly name of the client bank account record, this is to aid in identifying accounts
ID Unique reference for this client bank account record
Sort_Code Masked sort code of this client bank account record
SUN Service User Number that this client bank account is attached to
Sun_Friendly_Name A friendly name that is attached to this sun, this is to aid in identifying accounts

Instance URL

Instance_url/clientbankaccount

Response Sample


{
 "Client_Bank_Accounts": [
  {
   "Account_Number": "*****102",
   "Bank_Name": "Natwest",
   "Default_Account": false,
   "Friendly_Name": "Test SUn 1",
   "ID": "CBA-0000001",
   "Sort_Code": "****56",
   "Sun": "122",
   "Sun_Friendly_Name": "tes1"
   },
  {
   "Account_Number": "*****22",
   "Bank_Name": "Barclays",
   "Default_Account": true,
   "Friendly_Name": "bg2",
   "ID": "CBA-0000002",
   "Sort_Code": "****21",
   "Sun": "123",
    "Sun_Friendly_Name": "test"
  }
  ]
}

REST Commands

Client Bank Account By Sun GET


Response Parameters


Property Description
Account_Number Masked account number
Bank_Name Bank name that the account is registered to
Default_Account Boolean value, if true this is the default account that is registered to the service user number ( SUN )
Friendly_Name Friendly name of the client bank account record, this is to aid in identifying accounts
ID Unique reference for this client bank account record
Sort_Code Masked sort code of this client bank account record
SUN Service User Number that this client bank account is attached to
Sun_Friendly_Name A friendly name that is attached to this sun, this is to aid in identifying accounts

Instance URL

Instance_url/clientbankaccount/sun/{id}
{id} denotes record id

Response Sample


{
 "Client_Bank_Accounts":
  {
   "Account_Number": "*****102",
   "Bank_Name": "Natwest",
   "Default_Account": false,
   "Friendly_Name": "Test SUn 1",
   "ID": "CBA-0000001",
   "Sort_Code": "****56",
   "Sun": "122",
   "Sun_Friendly_Name": "tes1"
  }
}


REST Commands

Service User Number Overview


A Service User Number(SUN) is a unique identifier for organisations collecting payment by Direct Debit. All communications with Bacs require a SUN.


Method Purpose
GET Get list of all service user numbers ( SUNs ) - Instance_url/ServiceUserNumber
GET Get a single service user number record - Instance_url/ServiceUserNumber/{id}
{id} denotes ID of record

REST Commands

Service User Number GET


Response Parameters


Property Description
Default_Sun Boolean value, is this the default sun
SUN Service User Number
Sun_Friendly_Name A friendly name attached to the sun record to help aid in identifying between multiple suns
active Boolean value, if the sun is active or not

Instance URL

Instance_url/serviceusernumber/{id}
{id} denotes record id

Response Sample


{
 "Service_User_Number": {
  "Default_Sun": false,
  "SUN": "122",
  "Sun_Friendly_Name": "tes1",
 "active": true
  }
}

REST Commands

Service User Number List GET


Response Parameters


Property Description
Default_Sun Boolean value, is this the default sun
SUN Service User Number
Sun_Friendly_Name A friendly name attached to the sun record to help aid in identifying between multiple suns
active Boolean value, if the sun is active or not

Instance URL

Instance_url/serviceusernumber

Response Sample


{
 "Service_User_Number": [
   {
    "Default_Sun": false,
    "SUN": "122",
   "Sun_Friendly_Name": "tes1",
    "active": true
   },
   {
    "Default_Sun": true,
    "SUN": "123",
    "Sun_Friendly_Name": "test",
    "active": true
   }
  ]
}

Webhook API

Webhook Overview


Webhooks notify you of new events (e.g., when the bank informs us that one of your payments has failed). If an event occurs to a bank_account, mandate or payment in the DDMS, a webhook will be sent to every enabled webhook endpoint as a POST request.

Factors to consider with webhooks:
  • Webhooks may arrive out of order
  • Webhooks with an invalid signature must return a 498 Token Invalid error.
  • Webhooks about unknown events should be ignored, and return 204 No Content.
  • Webhook URLs must be HTTPS. Unsecured webhook URLs are not allowed.

Status codes
Your webhook handler should return a response with a 2xx status code, e.g. 200 OK, or 204 No Content.

Errors & Retries

In the event SmarterPay fail to deliver the webhook, or you respond with a non 2xx status code, SmarterPay will attempt to resend the webhook up to 10 times at increasing time intervals.

Webhook Resources

Webhook Resource Description
Bank Account These events are those that affect the status of the Bank Account and its ability to be used. These webhooks will be sent as a result of creating Bank Accounts
Mandate These events are those that affect the status of the Mandate and its ability to be used. These webhooks will be sent as a result of sending instructions to BACS and receiving ADDAC, AUDDIS , ARUDD and DDICA.
Payment / Credit These events are those that affect the status of individual Payment (from either a one off Payment or indeed Recurrence Scheduled Payment). These webhooks will be sent as a result of sending Payments or Credits to BACS and receiving ARUDD, ARUCS and AWACS.
Email These events are those that affect delivery of Email messages.

Webook API Samples

Bank Account


Response Parameters


Property Description
id Unique identifier of the webhook event
bank_account Unique bank account identifier
created_at Datetime formatted as ISO8601
resource_type Type of webhook response
account_number Account number of bank account record
sort_code Sort code of the bank account record
account_name Account name on the bank account record
currency Currency Field
enabled Status of current bank account record enabled field
bank_name Bank name
customer_account Unique id of the attached customer
bacs_reason_code If this event is to a bacs code then it will be displayed here else will be empty, see [this] section for more information
bacs_description Description of the bacs code if any are attached, see [this] section for more information
bacs_reference The reference number that BACS has given the specific report item
bacs_filename The original filename of the report provided by BACS



Response Sample



Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000003432",
   "bank_account":"BK000034432",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12343567",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"",
   "bacs_description":"",
   "bacs_reference":"",
   "bacs_filename":""
  }
 ]
}


Webook API Samples

Mandate


Response Parameters


Property Description
id Unique identifier of the webhook event
created_at Datetime formatted as ISO8601
resource_type Type of webhook response
customer_account Unique id of the attached customer
AUDDIS Unique bank account identifier
status Current Status - can be "new instruction", "first collection","ongoing collection","cancelled","cancelled by payer","cancelled by originator"
description Description of event
bacs_reason_code If this event is to a bacs code then it will be displayed here else will be empty, see [this] section for more information
bacs_description Description of the bacs code if any are attached, see [this] section for more information
bacs_reference The reference number that BACS has given the specific report item
bacs_filename The original filename of the report provided by BACS



Response Sample



Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000003432",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD00003403",
   "status":"new instruction",
   "description":"New instruction sent to BACS",
   "bacs_reason_code":"",
   "bacs_description":"",
   "bacs_reference":"",
   "bacs_filename":""
  }
 ]
}


Webook API Samples

Payment


Response Parameters


Property Description
id Unique identifier of the webhook event
created_at Datetime formatted as ISO8601
resource_type Type of webhook response
reference Payment ID
status Current Status - can be "submitted","failed","successful","cancelled"
description Description of event
bacs_reason_code If this event is to a bacs code then it will be displayed here else will be empty, see [this] section for more information
bacs_description Description of the bacs code if any are attached, see [this] section for more information
bacs_reference The reference number that BACS has given the specific report item
bacs_filename The original filename of the report provided by BACS



Response Sample



Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000003432",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"submitted",
   "description":"payment sent to bacs",
   "bacs_reason_code":"",
   "bacs_description":"",
   "bacs_reference":"",
   "bacs_filename":""
  }
 ]
}


Webook API Samples

Credit


Response Parameters


Property Description
id Unique identifier of the webhook event
created_at Datetime formatted as ISO8601
resource_type Type of webhook response
reference Payment ID
status Current Status - can be "submitted","failed","successful","cancelled"



Response Sample



Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CR000003402",
   "status":"submitted",
   "description":"payment sent to bacs",
   "bacs_reason_code":"",
   "bacs_description":"",
   "bacs_reference":"",
   "bacs_filename":""
  }
 ]
}


Webook API Samples

Email


Response Parameters


Property Description
id Unique identifier of the webhook event
email_id Email id reference
email Reciptant email address
created_at Datetime formatted as ISO8601
resource_type Type of webhook response
email_type Type of email that has been sent out
customer_account Unique customer account ID
auddis Unique AUDDIS ID
status Current Status
description Description of event



Response Sample



Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "email_id":"EM000005332",
   "email":"test@testuser.com",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"email",
   "email_type":"dd_confirmation",
   "customer_account":"CUST00034222",
   "auddis":"AUD0030000340"
   "status":"email_sent",
   "description":"email sent"
  }
 ]
}


Webook API Samples

Recurrence Schedule


Response Parameters


Property Description
id Unique identifier of the webhook event
created_at Datetime formatted as ISO8601
resource_type Type of webhook response
reference ID of the recurrence schedule
auddis Unique AUDDIS ID
status Current Status
description Description of event
bacs_reason_code If this event is to a bacs code then it will be displayed here else will be empty, see [this] section for more information
bacs_description Description of the bacs code if any are attached, see [this] section for more information
bacs_reference The reference number that BACS has given the specific report item
bacs_filename The original filename of the report provided by BACS



Response Sample



Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"recurrenceschedule",
   "reference":"REC000005332",
   "auddis":"AUD0030000340",
   "status":"inactive",
   "description":"recurrence schedule cancelled",
   "bacs_reason_code":"",
   "bacs_description":"",
   "bacs_reference":"",
   "bacs_filename":""
  }
 ]
}


BACS Codes

Overview


When a BACs report is recieved then a flow of actions may occur and involve webhooks been sent out. In this section the flow will be shown for each BACS code.

BACS Codes

ARUDD 0


Reason: Refer To Payer
Actions:
  • Payment:
    • An ARUDD0 webhook is sent for the payment. The payment status will be set to failed.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD0",
   "bacs_description":"refer to payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}



BACS Codes

ARUDD 1


Reason: Instruction Cancelled
Actions:
  • Payment:
    • An ARUDD1 webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS message and our API would have sent an ADDACS webhook for the mandate. If, however, this hasn't happened then an ARUDD1 webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDD1 webhook is sent for each.

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD1"
   "bacs_description":"instruction cancelled",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDD1"
   "bacs_description":"instruction cancelled",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}



BACS Codes

ARUDD 2


Reason: Payer Deceased
Actions:
  • Payment:
    • An ARUDD2 webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS or AUDDIS message and our API would have sent an ADDACS or AUDDIS webhook for the mandate. If, however, this hasn't happened an ARUDD2 webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDD2 webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled by an ADDACS, an ARUDD2 webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUDD2 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDD2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"ARUDD2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ARUDD2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}



BACS Codes

ARUDD 3


Reason: Account Transferred
Actions:
  • Payment:
    • An ARUDD3 webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS or AUDDIS message and our API would have sent an ADDACS or AUDDIS webhook for the mandate. If, however, this hasn't happened an ARUDD3 webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDD3 webhook is sent for each.
  • Bank Account:
    • If new bank details have been supplied, an ARUDD3 webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
    • If new bank details have not been supplied, an ARUDD3 webhook is sent and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUDD3 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD3",
   "bacs_description":"account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDD3",
   "bacs_description":"account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false/true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"ARUDD3",
   "bacs_description":"account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ARUDD3",
   "bacs_description":"account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD 4


Reason: Advance Notice Disputed
Actions:
  • Payment:
    • An ARUDD4 webhook is sent for the payment. The payment status will be set to failed.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD4",
   "bacs_description":"advance notice disputed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD 5


Reason: No Account Or Wrong Account Type
Actions:
  • Payment:
    • An ARUDD5 webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS or AUDDIS message and our API would have sent an ADDACS or AUDDIS webhook for the mandate. If, however, this hasn't happened an ARUDD5 webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDD5 webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled by an ADDACS, an ARUDD5 webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUDD5 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD5",
   "bacs_description":"no account (or wrong account type)",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDD5",
   "bacs_description":"no account (or wrong account type)",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"ARUDD5",
   "bacs_description":"no account (or wrong account type)",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ARUDD5",
   "bacs_description":"no account (or wrong account type)",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD 6


Reason: No Instruction
Actions:
  • Payment:
    • An ARUDD6 webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS message and our API would have sent an ADDACS webhook for the mandate. If, however, this hasn't happened then we automatically send an ARUDD6 webhook for the mandate and set the status to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDD6 webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD6",
   "bacs_description":"no instruction",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDD6",
   "bacs_description":"no instruction",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD 7


Reason: Amount Differs
Actions:
  • Payment:
    • An ARUDD7 webhook is sent for the payment. The payment status will be set to failed.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD7",
   "bacs_description":"amount differs",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD 8


Reason: Amount Not Yet Due
Actions:
  • Payment:
    • An ARUDD8 webhook is sent for the payment. The payment status will be set to failed.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD8",
   "bacs_description":"amount not yet due",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD 9


Reason: Presentation Overdue
Actions:
  • Payment:
    • An ARUDD9 webhook is sent for the payment. The payment status will be set to failed.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDD9",
   "bacs_description":"presentation overdue",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}




BACS Codes

ARUDD A


Reason :Service user differs
Actions:
  • Payment:
    • An ARUDDA webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS message and our API would have sent an ADDACS webhook for the mandate. If, however, this hasn't happened then we automatically send an ARUDDA webhook for the mandate and set the status to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDDA webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDDA",
   "bacs_description":"service user differs",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDDA",
   "bacs_description":"service user differs",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}



BACS Codes

ARUDD B


Reason :Account Closed
Actions:
  • Payment:
    • An ARUDDB webhook is sent for the payment. The payment status will be set to failed.
  • Mandate:
    • BACS should have already sent an appropriate ADDACS or AUDDIS message and our API would have sent an ADDACS or AUDDIS webhook for the mandate. If, however, this hasn't happened an ARUDDB webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Any other unsubmitted payments related to the mandate will also be cancelled and an ARUDDB webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled by an ADDACS, an ARUDDB webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUDDB webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"failed",
   "description":"payment failed",
   "bacs_reason_code":"ARUDDB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ARUDDB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"ARUDDB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ARUDDB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Arudd010319111111"
  }
 ]
}



BACS Codes

ADDACS 0


Reason: Instruction Cancelled - Refer To Payer
Actions:
  • Mandate:
    • An ADDACS0 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an ADDACS0 webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ADDACS0",
   "bacs_description":"instruction cancelled - refer to payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACS0",
   "bacs_description":"instruction cancelled - refer to payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS 1


Reason: Instruction Cancelled By Payer
Actions:
  • Mandate:
    • An ADDACS1 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an ADDACS1 webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ADDACS1",
   "bacs_description":"instruction cancelled by payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACS1",
   "bacs_description":"instruction cancelled by payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS 2


Reason: Payer Deceased
Actions:
  • Mandate:
    • An ADDACS2 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an ADDACS2 webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled, an ADDACS2 webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ADDACS2 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ADDACS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"ADDACS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ADDACS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS 3


Reason: Instruction Cancelled, Account Transferred
Actions:
  • Mandate:
    • An ADDACS3 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an ADDACS3 webhook is sent for each.
  • Bank Account:
    • If new bank details have been supplied, an ADDACS3 webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
    • If new bank details have not been supplied, an ADDACS3 webhook is sent and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ADDACS3 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ADDACS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACS3"
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false/true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST00002323232",
   "bacs_reason_code":"ADDACS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ADDACS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS B


Reason: Account Closed
Actions:
  • Mandate:
    • An ADDACSB webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an ADDACSB webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled, an ADDACSB webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ADDACSB webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ADDACSB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACSB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"ADDACSB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"ADDACSB",
   "bacs_description":"account closed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS C


Reason: Account transferred to a different branch
Actions:
  • Mandate:
    • An ADDACSC webhook for the mandate is sent. The status remains as previously set.
  • Bank Account:
    • An ADDACSC webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"(as previously set)",
   "description":"mandate is available for collections",
   "bacs_reason_code":"ADDACSC",
   "bacs_description":"account transferred to a different branch of bank/building society",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST00002323232",
   "bacs_reason_code":"ADDACSC",
   "bacs_description":"account transferred to a different branch of bank/building society",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS D


Reason: Advance notice disputed
Actions:
  • Mandate:
    • An ADDACSD webhook for the mandate is sent. The status remains as previously set.
  • Payment:
    • Any unsubmitted payments related to the mandate will be cancelled and an ADDACSD webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"(as previously set)",
   "description":"mandate is available for collections",
   "bacs_reason_code":"ADDACSD",
   "bacs_description":"advance notice disputed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACSD",
   "bacs_description":"advance notice disputed",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}


BACS Codes

ADDACS E


Reason: Instruction Amended
Actions:
  • Mandate:
    • An ADDACSE webhook for the mandate is sent. The status remains as previously set.
  • Bank Account:
    • An ADDACSE webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"(as previously set)",
   "description":"mandate is available for collections",
   "bacs_reason_code":"ADDACSE",
   "bacs_description":"instruction amended",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST00002323232",
   "bacs_reason_code":"ADDACSE",
   "bacs_description":"instruction amended",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}



BACS Codes

ADDACS R


Reason: Instruction Reinstated
Actions:
If code received less than two months from cancellation:
  • Mandate:
    • An ADDACSR webhook for the mandate is sent for notification that an ADDACS R has been received. No changes to the mandate will occur.
If code received more than two months from cancellation:
  • Mandate:
    • An ADDACSR webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an ADDACSR webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"ongoing collection/cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"ADDACSR",
   "bacs_description":"instruction reinstated",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"ADDACSR",
   "bacs_description":"instruction reinstated",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"Addacs020419111111"
  }
 ]
}


BACS Codes

AUDDIS 1


Reason: Instruction Cancelled By Payer
Actions:
  • Mandate:
    • An AUDDIS1 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDIS1 webhook is sent for each.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"AUDDIS1",
   "bacs_description":"instruction cancelled by payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"AUDDIS1",
   "bacs_description":"instruction cancelled by payer",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}



BACS Codes

AUDDIS 2


Reason: Payer Deceased
Actions:
  • Mandate:
    • An AUDDIS2 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDIS2 webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled, an AUDDIS2 webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDIS2 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"AUDDIS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"AUDDIS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"AUDDIS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"AUDDIS2",
   "bacs_description":"payer deceased",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}



BACS Codes

AUDDIS 3


Reason: Account Transferred
Actions:
  • Mandate:
    • An AUDDIS3 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDIS3 webhook is sent for each.
  • Bank Account:
    • If new bank details have been supplied, an AUDDIS3 webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
    • If new bank details have not been supplied, an AUDDIS3 webhook is sent and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDIS3 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"AUDDIS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"AUDDIS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345678",
   "sort_code":"123456",
   "account_name":"Test User",
   "currency":"GBP",
   "enabled":false/true,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000000342",
   "bacs_reason_code":"AUDDIS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"AUDDIS3",
   "bacs_description":"instruction cancelled, account transferred",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}



BACS Codes

AUDDIS 5


Reason: No Account
Actions:
  • Mandate:
    • An AUDDIS5 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDIS5 webhook is sent for each.
  • Bank Account:
    • If the bank account has not already been disabled, an AUDDIS5 webhook is sent for the bank account and the record is disabled.
    • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDIS5 webhook is sent for each.
    • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"mandate",
   "customer_account":"CUST000003402",
   "AUDDIS":"AUD0000000340",
   "status":"cancelled by payer",
   "description":"mandate is no longer available for collections",
   "bacs_reason_code":"AUDDIS5",
   "bacs_description":"no account",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"payment",
   "reference":"PM000003402",
   "status":"cancelled",
   "description":"payment cancelled",
   "bacs_reason_code":"AUDDIS5",
   "bacs_description":"no account",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "bank_account":"BA0000055532",
   "updated_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"bank_account",
   "account_number":"12345667",
   "sort_code":"123456",
   "account_name":"Test Name",
   "currency":"GBP",
   "enabled":false,
   "bank_name":"BARCLAYS BANK PLC",
   "customer_account":"CUST000003402",
   "bacs_reason_code":"AUDDIS5",
   "bacs_description":"no account",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}

Webhook-Signature:
64b20970b415b066e3d21459ea5150528
{
 "events":
 [
  {
   "id":"EV000005332",
   "created_at":"2017-02-18T12:00:00.000Z",
   "resource_type":"credit",
   "reference":"CRE0000000230",
   "status":"cancelled",
   "description":"credit cancelled",
   "bacs_reason_code":"AUDDIS5",
   "bacs_description":"no account",
   "bacs_reference":"XYZ0018516-0016536",
   "bacs_filename":"AuddisReturnedDDI040219111111"
  }
 ]
}



BACS Codes

AUDDIS 6


Reason: No Instruction
Actions:
  • Mandate:
    • An AUDDIS6 webhook for the mandate is sent and the status is set to "cancelled by payer".
  • Payment:
    • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDIS6 webhook is sent for each.
  • Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDIS6",
       "bacs_description":"no instruction",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDIS6",
       "bacs_description":"no instruction",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS B


    Reason: Account Closed
    Actions:
    • Mandate:
      • An AUDDISB webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISB webhook is sent for each.
    • Bank Account:
      • If the bank account has not already been disabled, an AUDDISB webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDISB webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISB",
       "bacs_description":"account closed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISB",
       "bacs_description":"account closed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000003402",
       "bacs_reason_code":"AUDDISB",
       "bacs_description":"account closed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"cancelled",
       "description":"credit cancelled",
       "bacs_reason_code":"AUDDISB",
       "bacs_description":"account closed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS C


    Reason: Account transferred to a different branch of bank/building society
    Actions:
    • Mandate:
      • An AUDDISC webhook for the mandate is sent. The status remains as previously set.
    • Bank Account:
      • An AUDDISC webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"(as previously set)",
       "description":"mandate is available for collections",
       "bacs_reason_code":"AUDDISC",
       "bacs_description":"account transferred to a different branch of bank/building society",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345678",
       "sort_code":"123456",
       "account_name":"Test User",
       "currency":"GBP",
       "enabled":true,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000000342",
       "bacs_reason_code":"AUDDISC",
       "bacs_description":"account transferred to a different branch of bank/building society",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS F


    Reason: Invalid account type
    Actions:
    • Mandate:
      • An AUDDISF webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISF webhook is sent for each.
    • Bank Account:
      • If the bank account has not already been disabled, an AUDDISF webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDISF webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISF",
       "bacs_description":"invalid account type",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISF",
       "bacs_description":"invalid account type",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000003402",
       "bacs_reason_code":"AUDDISF",
       "bacs_description":"invalid account type",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"cancelled",
       "description":"credit cancelled",
       "bacs_reason_code":"AUDDISF",
       "bacs_description":"invalid account type",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS G


    Reason: Bank will not accept Direct Debits on account
    Actions:
    • Mandate:
      • An AUDDISG webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISG webhook is sent for each.
    • Bank Account:
      • If the bank account has not already been disabled, an AUDDISG webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDISG webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISG",
       "bacs_description":"bank will not accept direct debits on account",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISG",
       "bacs_description":"bank will not accept direct debits on account",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000003402",
       "bacs_reason_code":"AUDDISG",
       "bacs_description":"bank will not accept direct debits on account",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"cancelled",
       "description":"credit cancelled",
       "bacs_reason_code":"AUDDISG",
       "bacs_description":"bank will not accept direct debits on account",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS H


    Reason: Instruction has expired
    Actions:
    • Mandate:
      • An AUDDISH webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISH webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISH",
       "bacs_description":"instruction expired",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISH",
       "bacs_description":"instruction expired",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS I


    Reason: Payer Reference is not unique
    Actions:
    • Mandate:
      • An AUDDISI webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISI webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISI",
       "bacs_description":"payer reference is not unique",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISI",
       "bacs_description":"payer reference is not unique",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS K


    Reason: Instruction cancelled by bank
    Actions:
    • Mandate:
      • An AUDDISK webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISK webhook is sent for each.
    • Bank Account:
      • If the bank account has not already been disabled, an AUDDISK webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDISK webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISK",
       "bacs_description":"instruction cancelled by bank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISK",
       "bacs_description":"instruction cancelled by bank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000003402",
       "bacs_reason_code":"AUDDISK",
       "bacs_description":"instruction cancelled by bank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"cancelled",
       "description":"credit cancelled",
       "bacs_reason_code":"AUDDISK",
       "bacs_description":"instruction cancelled by bank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS L


    Reason: Incorrect payers account details
    Actions:
    • Mandate:
      • An AUDDISL webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISL webhook is sent for each.
    • Bank Account:
      • If the bank account has not already been disabled, an AUDDISL webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDISL webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISL",
       "bacs_description":"incorrect payers account details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISL",
       "bacs_description":"incorrect payers account details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000003402",
       "bacs_reason_code":"AUDDISL",
       "bacs_description":"incorrect payers account details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"cancelled",
       "description":"credit cancelled",
       "bacs_reason_code":"AUDDISL",
       "bacs_description":"incorrect payers account details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS M


    Reason: Transaction code/User status Incompatible
    Actions:
    • Mandate:
      • An AUDDISM webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISM webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISM",
       "bacs_description":"transaction code/user status incompatible",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISM",
       "bacs_description":"transaction code/user status incompatible",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS N


    Reason: Transaction disallowed at payers branch
    Actions:
    • Mandate:
      • An AUDDISN webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISN webhook is sent for each.
    • Bank Account:
      • If the bank account has not already been disabled, an AUDDISN webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an AUDDISN webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISN",
       "bacs_description":"transaction disallowed at payers branch",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISN",
       "bacs_description":"transaction disallowed at payers branch",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000003402",
       "bacs_reason_code":"AUDDISN",
       "bacs_description":"transaction disallowed at payers branch",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"cancelled",
       "description":"credit cancelled",
       "bacs_reason_code":"AUDDISN",
       "bacs_description":"transaction disallowed at payers branch",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS O


    Reason: Invalid Reference
    Actions:
    • Mandate:
      • An AUDDISO webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISO webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISO",
       "bacs_description":"invalid reference",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISO",
       "bacs_description":"invalid reference",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS P


    Reason: Payers name not present
    Actions:
    • Mandate:
      • An AUDDISP webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISP webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISP",
       "bacs_description":"payers name not present",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISP",
       "bacs_description":"payers name not present",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    AUDDIS Q


    Reason: Service user name is blank
    Actions:
    • Mandate:
      • An AUDDISQ webhook for the mandate is sent and the status is set to "cancelled by payer".
    • Payment:
      • Any unsubmitted payments related to the mandate will also be cancelled and an AUDDISQ webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"AUDDISQ",
       "bacs_description":"service username is blank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PM000003402",
       "status":"cancelled",
       "description":"payment cancelled",
       "bacs_reason_code":"AUDDISQ",
       "bacs_description":"service username is blank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"AuddisReturnedDDI040219111111"
      }
     ]
    }



    BACS Codes

    DDICA 1


    Reason: Amount and or date of DD differs from Advance Notice
    Actions:
    • Payment:
      • A DDICA1 webhook for the payment is sent and the status is set to "indemnity_claimed".
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA1",
       "bacs_description":"amount and or date of dd differs",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 2


    Reason: No Advance notice received by payer/or the amount is disputed
    Actions:
    • Payment:
      • A DDICA2 webhook for the payment is sent and the status is set to "indemnity_claimed".
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA2",
       "bacs_description":"no advance notice received",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 3


    Reason: DDI Cancelled by paying bank
    Actions:
    • Payment:
      • A DDICA3 webhook for the payment is sent and the status is set to "indemnity_claimed".
    • Mandate:
      • An DDICA3 webhook for the mandate is sent and the status is set to "cancelled by payer".
      • Any unsubmitted payments related to the mandate will also be cancelled and an DDICA3 webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA3",
       "bacs_description":"ddi cancelled by paying bank",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"DDICA3",
       "bacs_description":"ddi cancelled by paying bank",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 4


    Reason: Payer cancelled DDI direct with the service user
    Actions:
    • Payment:
      • A DDICA4 webhook for the payment is sent and the status is set to "indemnity_claimed".
    • Mandate:
      • An DDICA4 webhook for the mandate is sent and the status is set to "cancelled by payer".
      • Any unsubmitted payments related to the mandate will also be cancelled and an DDICA4 webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA4",
       "bacs_description":"payer has cancelled ddi direct with service user",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"DDICA4",
       "bacs_description":"payer has cancelled ddi direct with service user",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 5


    Reason: No instruction held/payer disputes having given authority
    Actions:
    • Payment:
      • A DDICA5 webhook for the payment is sent and the status is set to "indemnity_claimed".
    • Mandate:
      • An DDICA5 webhook for the mandate is sent and the status is set to "cancelled by payer".
      • Any unsubmitted payments related to the mandate will also be cancelled and an DDICA5 webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA5",
       "bacs_description":"no instruction held",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"DDICA5",
       "bacs_description":"no instruction held",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 6


    Reason: Signature is fraudulent or not in accordance with authorised signatory
    Actions:
    • Payment:
      • A DDICA6 webhook for the payment is sent and the status is set to "indemnity_claimed".
    • Mandate:
      • An DDICA6 webhook for the mandate is sent and the status is set to "cancelled by payer".
      • Any unsubmitted payments related to the mandate will also be cancelled and an DDICA6 webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA6",
       "bacs_description":"signature on ddi is fraudulent",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"DDICA6",
       "bacs_description":"signature on ddi is fraudulent",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 7


    Reason: Claim raised at service users request after DD applied to payers accounts
    Actions:
    • Payment:
      • A DDICA7 webhook for the payment is sent and the status is set to "indemnity_claimed".
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA7",
       "bacs_description":"claim raised at service users request",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    DDICA 8


    Reason: Service user name disputed/payer does not recognise service user collecting direct debit
    Actions:
    • Payment:
      • A DDICA8 webhook for the payment is sent and the status is set to "indemnity_claimed".
    • Mandate:
      • An DDICA8 webhook for the mandate is sent and the status is set to "cancelled by payer".
      • Any unsubmitted payments related to the mandate will also be cancelled and an DDICA8 webhook is sent for each.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"payment",
       "reference":"PAYM00000001",
       "status":"indemnity_claimed",
       "description":"indemnity debit applied",
       "bacs_reason_code":"DDICA8",
       "bacs_description":"service user name disputed",
       "collection_date":2018-06-15",
       "amount":"23.57",
       "debit_date":"2018-03-20",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"mandate",
       "customer_account":"CUST000003402",
       "AUDDIS":"AUD0000000340",
       "status":"cancelled by payer",
       "description":"mandate is no longer available for collections",
       "bacs_reason_code":"DDICA8",
       "bacs_description":"service user name disputed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"DDICA040319111111"
      }
     ]
    }


    BACS Codes

    ARUCS 0


    Reason: Invalid Details
    Actions:
    • Credit:
      • An ARUCS0 webhook for the credit is sent and the status is set to "credit failed".
    • Bank Account:
      • If the bank account has not already been disabled, an ARUCS0 webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUCS0 webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"failed",
       "description":"credit failed",
       "bacs_reason_code":"ARUCS0",
       "bacs_description":"invalid details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST00002323232",
       "bacs_reason_code":"ARUCS0",
       "bacs_description":"invalid details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }


    BACS Codes

    ARUCS 2


    Reason: Beneficiary Deceased
    Actions:
    • Credit:
      • An ARUCS2 webhook for the credit is sent and the status is set to "credit failed".
    • Bank Account:
      • If the bank account has not already been disabled, an ARUCS2 webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUCS2 webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"failed",
       "description":"credit failed",
       "bacs_reason_code":"ARUCS2",
       "bacs_description":"beneficiary deceased",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST00002323232",
       "bacs_reason_code":"ARUCS2",
       "bacs_description":"beneficiary deceased",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }


    BACS Codes

    ARUCS 3


    Reason: Account Transferred
    Actions:
    • Credit:
      • An ARUCS3 webhook for the credit is sent and the status is set to "credit failed".
    • Bank Account:
      • If new bank details have not been updated by any other bacs code, an ARUCS3 webhook is sent and the record is disabled.
        • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUCS3 webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"failed",
       "description":"credit failed",
       "bacs_reason_code":"ARUCS3",
       "bacs_description":"account transferred",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false/true,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST00002323232",
       "bacs_reason_code":"ARUCS3",
       "bacs_description":"account transferred",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }


    BACS Codes

    ARUCS 5


    Reason: Account number is not recognised at the receiving bank
    Actions:
    • Credit:
      • An ARUCS5 webhook for the credit is sent and the status is set to "credit failed".
    • Bank Account:
      • If the bank account has not already been disabled, an ARUCS5 webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUCS5 webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"failed",
       "description":"credit failed",
       "bacs_reason_code":"ARUCS5",
       "bacs_description":"account number not recognised",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST00002323232",
       "bacs_reason_code":"ARUCS5",
       "bacs_description":"account number not recognised",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }


    BACS Codes

    ARUCS B


    Reason: Account Closed
    Actions:
    • Credit:
      • An ARUCSB webhook for the credit is sent and the status is set to "credit failed".
    • Bank Account:
      • If the bank account has not already been disabled, an ARUCSB webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUCSB webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"failed",
       "description":"credit failed",
       "bacs_reason_code":"ARUCSB",
       "bacs_description":"account closed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST00002323232",
       "bacs_reason_code":"ARUCSB",
       "bacs_description":"account closed",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }


    BACS Codes

    ARUCS C


    Reason: Requested by remitter
    Actions:
    • Credit:
      • An ARUCSC webhook for the credit is sent and the status is set to "credit failed".
    • Bank Account:
      • If the bank account has not already been disabled, an ARUCSC webhook is sent for the bank account and the record is disabled.
      • Any unsubmitted credits connected to this bank account will have their status set to "credit cancelled" and an ARUCSC webhook is sent for each.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "created_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"credit",
       "reference":"CRE0000000230",
       "status":"failed",
       "description":"credit failed",
       "bacs_reason_code":"ARUCSC",
       "bacs_description":"requested by remitter",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }

    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA0000055532",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345667",
       "sort_code":"123456",
       "account_name":"Test Name",
       "currency":"GBP",
       "enabled":false,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST00002323232",
       "bacs_reason_code":"ARUCSC",
       "bacs_description":"requested by remitter",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Arucs250219111111"
      }
     ]
    }


    BACS Codes

    AWACS 0


    Reason: Invalid Details
    Actions:
    • Bank Account:
      • An AWACS0 webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA000005332",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345678",
       "sort_code":"123456",
       "account_name":"Test User",
       "currency":"GBP",
       "enabled":true,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000000342",
       "bacs_reason_code":"AWACS0",
       "bacs_description":"invalid details",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"Awacs010419111111"
      }
     ]
    }


    BACS Codes

    AWACS 3


    Reason: Account Transferred
    Actions:
    • Bank Account:
      • An AWACS3 webhook with the updated details, such as sort code and account number, of the bank account is sent and the record remains enabled.
      • Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
    Webhook-Signature:
    64b20970b415b066e3d21459ea5150528
    {
     "events":
     [
      {
       "id":"EV000005332",
       "bank_account":"BA000005332",
       "updated_at":"2017-02-18T12:00:00.000Z",
       "resource_type":"bank_account",
       "account_number":"12345678",
       "sort_code":"123456",
       "account_name":"Test User",
       "currency":"GBP",
       "enabled":true,
       "bank_name":"BARCLAYS BANK PLC",
       "customer_account":"CUST000000342",
       "bacs_reason_code":"AWACS3",
       "bacs_description":"account transferred",
       "bacs_reference":"XYZ0018516-0016536",
       "bacs_filename":"222512960-PE_UDD_USER_COPY20180804023210"
      }
     ]
    }

    Changelog

    December 2019 Release

    Functional Changes - Recurrence Schedule
    • Improved functionality on recurrence schedules.
    Bug Fixes
    • Cancelling payments would cause two audit messages to be inserted, this now only inserts one.
    • Improved responses on invalid requests.
    • Performance Upgrade.

    April 2019 Release

    Text Changes
    • Fixed a typo changing ARUDD to ARRUD to match BACS error codes
    • Fixed a typo in where some webhooks were been sent as 'Mandate is no longer available for collections' and 'mandate is no longer available for collections'
    • Mandate, credit, SUN and client bank account overview description on wiki changed
    • Standardised the term 'payers' throughout the webhooks.

    Functional Changes - Mandate
    • In order to accommate multiple suns, mandate post will require a client bank account ID, if this is not supplied it will use the default client bank account attached to the default Service User Number (SUN).
    • Records been returned will give the SUN name, SUN number,client bank account ID, originator sort code and originator account number.

    Functional Changes - Credit
    • In order to issue credits either an AUDDIS ID or a Client Bank Account ID Must be supplied, if neither are supplied it will use the default client bank account attached to the default sun.
    • Credit recirds will return the SUN name, SUN number and the client bank account ID it is attached to.

    Functional Changes - Client Bank Account
    • Get Method (Singlar) added - allows to get information on a Client bank account record by ID
    • Get Method (List) added - Gets a list of all client bank account records
    • Get Method (By SUN) added - allows to get a list of all client bank accounts attached to a supplied sun

    Functional Changes - Service User Number
    • Get Method (Singlar) added - allows to get a details of the supplied sun number
    • Get Method (list) added - allows to get a list of suns attached to the client
    Webhook API
    General:
    • Updated 'description' and 'bacs_description' to lower case for consistency.
    • Added 'bacs_reference' and 'bacs_filename' to each webhook message to easily track the cause of the message.
    • Updated webhook description and sample format.
    ARUDD:
    • Updated ARUDD2, ARUDD5 and ARUDDB to cancel the related mandate, cancel any other unsubmitted payments, disable the bank account and cancel any other unsubmitted credits. Webhooks are sent for each action.
    • Updated ARUDD3 to update the related bank account with new details if they have been supplied. If they have not been provided, the related bank account is disabled any unsubmitted credits are cancelled. Webhooks are sent for each action.
    • Updated ARUDD4, ARUDD7, ARUDD8 and ARUDD9 to no longer cancel the mandate, it now stays in the same status.
    ADDACS:
    • Updated ADDACS2 and ADDACSB to cancel the related mandate, cancel any other unsubmitted payments, disable the bank account and cancel any other unsubmitted credits. Webhooks are sent for each action.
    • Updated ADDACS3 to update the related bank account with new details if they have been supplied. If they have not been provided, the related bank account is disabled any unsubmitted credits are cancelled. Webhooks are sent for each action.
    • Updated ADDACSD to no longer cancel the mandate, it now stays in the same status.
    • Updated ADDACSR to correctly process reinstatements if they are received less or more than 2 months from cancellation.
    AUDDIS:
    • Updated AUDDIS2, AUDDIS5, AUDDISB, AUDDISF, AUDDISG, AUDDISK, AUDDISL and AUDDISN to cancel the related mandate, cancel any other unsubmitted payments, disable the bank account and cancel any other unsubmitted credits. Webhooks are sent for each action.
    • Updated AUDDIS3 to update the related bank account with new details if they have been supplied. If they have not been provided, the related bank account is disabled any unsubmitted credits are cancelled. Webhooks are sent for each action.
    DDICA:
    • Updated DDICA1 to the correct reason.
    • Updated DDICA3, DDICA4, DDICA5, DDICA6 and DDICA8 to cancel the related mandate and cancel any other unsubmitted payments. Webhooks are sent for each action.
    ARUCS:
    • Updated ARUCS0, ARUCS2, ARUCS5, ARUCSB and ARUCSC to disable the related bank account and cancel any other unsubmitted credits. Webhooks are sent for each action.
    • Updated ARUCS3 to update the related bank account with new details if they have been supplied. If they have not been provided, the related bank account is disabled any unsubmitted credits are cancelled. Webhooks are sent for each action.

    Portal Changes
    • Notification bar added to indicate the deadline for payments and file submissions for the processing date stated.
    • Overview page removed for bacs submitter only clients
    • Mandates now have the ability to choose the SUN and originator account when issuing a new instruction, payments connected to the mandate will now be collected to the registered sun
    • Creating payments in the portal now automatically selects the first available processing date.
    • Credits now have the ability to have SUNs and originator accounts attached to them.
    • File submission optimisation
    • Multiple file format support
    • Multiple sun support
    • Multiple client bank account support
    • Single line file mapping added
    • Profile additions, enabling certain users to see certain SUNs