Invalid account type
Please see the settings in the custom profile for actions.
Please see the Webhook Subscription for which Webhooks will be sent out for the customised actions.
Object | Action | Webhook Subscription Criteria |
---|---|---|
Mandate | The Mandate will be cancelled. | “DDMS Service” “Edit” on the Mandate object. |
Payment - Pending | Any unsubmitted Payments related to the Mandate will be cancelled. | “DDMS Service” “Edit” on the Payment object. |
Recurrence Schedule | Any Recurrence Schedules related to the Mandate will be disabled. | “DDMS Service” “Edit” on Scheduled Payment object. |
Bank Account | If the Bank Account has not already been disabled, it will be disabled. | “DDMS Service” “Edit” on the Bank Account object. |
Credit - Pending | Any unsubmitted Credits related to the Bank Account will be cancelled. | “DDMS Service” “Edit” on the Credit object. |
Any other mandates connected to the bank account will receive their own ADDACS, AUDDIS or ARUDD report and are therefore updated independently.
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
description | mandate is no longer available for collections |
status | cancelled by payer |
bacs_reason_code | AUDDISF |
bacs_description | invalid account type |
bacs_reference | XYZ0012345-0012345 |
bacs_filename | Auddis020419111111.xml |
{ "events": [ { "id" : {EVENTID}, "created_at" : {CREATEDDATE}, "resource_type": {RESOURCETYPE}, "event_source" : {EVENTSOURCE}, "customer_account" : {CUSTOMERACCOUNT}, "AUDDIS" : {AUDDIS}, "status" : {STATUS}, "description" : {DESCRIPTION}, "bacs_reason_code" : {BACSCODE}, "bacs_description" : {BACSDESCRIPTION}, "bacs_reference" : {BACSREFERENCE}, "bacs_filename" : {BACSFILENAME}, "reference": {REFERENCE} } ] }
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
event_type | “mandate.update” |
event_source | “DDMS service” |
status | “cancelled by payer” |
bacs_reason_code | “AUDDISF” |
bacs_description | “invalid account type” |
bacs_reference | “XYZ0012345-0012345” |
bacs_filename | “Auddis020419111111.xml” |
{ "id":{VALUE}, "idempotency_key":{VALUE}, "sent_at":{VALUE}, "client": { "id":{VALUE} }, "events":[ { "id":{VALUE}, "event_id":{VALUE}, "reference":{VALUE}, "created_at":{VALUE}, "edited_at":{VALUE}, "status":{VALUE}, "i_am_the_only_account_holder":{VALUE}, "bacs_reason_code":{VALUE}, "bacs_description":{VALUE}, "event_type":{VALUE}, "event_source":{VALUE}, "bacs_reference":{VALUE}, "bacs_filename":{VALUE}, "metadata":{VALUE}, "created_by":{ "id":{VALUE} }, "edited_by":{ "id":{VALUE} }, "customer_account":{ "id":{VALUE}, "legacy_id":{VALUE} }, "bank_account":{ "id":{VALUE}, "legacy_id":{VALUE}, "account_name":{VALUE}, "account_number":{VALUE}, "sort_code":{VALUE}, "bank_name":{VALUE} }, "originating_bank_account":{ "id":{VALUE}, "legacy_id":{VALUE} "account_name":{VALUE}, "account_number":{VALUE}, "sort_code":{VALUE} }, "service_user_number":{ "id":{VALUE}, "sun_name":{VALUE}, "sun_number":{VALUE}, }, "client":{ "id":{VALUE} }, "account_validation": [ { "id": {VALUE}, "account_name_match": {VALUE}, "validation_performed": {VALUE}, "validation_link": {VALUE}, "created_at": {VALUE}, "edited_at": {VALUE} } ] } ] }
Note: Property display order for documentation purposes, actual order may vary.
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
description | payment cancelled |
status | cancelled |
bacs_reason_code | AUDDISF |
bacs_description | invalid account type |
bacs_reference | 2022080301S102184102 |
bacs_filename | Auddis020419111111.xml |
{ "events": [ { "id" : {EVENTID}, "created_at" : {CREATEDDATE}, "resource_type": {RESOURCETYPE}, "reference" : {REFERENCE}, "status" : {STATUS}, "description" : {DESCRIPTION}, "event_source": {EVENTSOURCE}, "bacs_reason_code" : {BACSCODE}, "bacs_description" : {BACSDESCRIPTION}, "collection_date": {COLLECTIONDATE}, "amount": {AMOUNT}, "debit_date": {DEBITDATE} , "bacs_reference" : {BACSREFERENCE}, "bacs_filename" : {BACSFILENAME}, "record_type" : {RECORDTYPE}, "custom_reference" : {CUSTOMREFERENCE}, "customer_account" : {CUSTOMERACCOUNT}, "card_id" : {CARDID}, "payment_type" : {PAYMENTTYPE}, "status_details" : {STATUSDETAILS}, "status_code" : {STATUSCODE}, "currency_code" : {CURRENCYCODE}, "internal_payment_description" : {INTERNALPAYMENTDESCRIPTION}, "gateway_payment_description" : {GATEWAYPAYMENTDESCRIPTION}, "authorisation_code" : {AUTHORISATIONCODE}, "transaction_id" : {TRANSACTIONID}, "order_id" : {ORDERID}, "charge_id" : {CHARGEID}, "metadata" : {METADATA}, "gateway_status" : {GATEWAYSTATUS}, "gateway_status_code" : {GATEWAYSTATUSCODE}, "gateway_status_details" : {GATEWAYSTATUSDETAILS}, "related_payment_id" : {RELATEDPAYMENTID}, "reference": {REFERENCE} } ] }
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
event_type | “payment.update” |
event_source | “DDMS service” |
status | “cancelled” |
bacs_reason_code | “AUDDISF” |
bacs_description | “invalid account type” |
bacs_reference | “XYZ0012345-0012345” |
bacs_filename | “Auddis020419111111.xml” |
{ "id":{VALUE}, "idempotency_key":{VALUE}, "sent_at":{VALUE}, "client":{ "id":{VALUE} }, "events":[ { "id":{VALUE}, "legacy_id":{VALUE}, "created_at":{VALUE}, "collection_date":{VALUE}, "currency_code":{VALUE}, "amount":{VALUE}, "payment_type":{VALUE}, "status":{VALUE}, "edited_at":{VALUE}, "represented_collection_date":{VALUE}, "custom_reference":{VALUE}, "event_source":{VALUE}, "record_type":{VALUE}, "description":{VALUE}, "event_type":{VALUE}, "metadata":{VALUE}, "client":{ "id":{VALUE} }, "created_by":{ "id":{VALUE} }, "edited_by":{ "id":{VALUE} }, "customer_account":{ "id":{VALUE}, "legacy_id":{VALUE} }, "recurrence_schedule":{ "id":{VALUE}, "legacy_id":{VALUE} }, "related_payment":{ "id":{VALUE}, "legacy_id":{VALUE} }, "direct_debit":{ "bacs_reference":{VALUE}, "bacs_filename":{VALUE}, "bacs_reason_code":{VALUE}, "bacs_description":{VALUE}, "overriding_name":{VALUE}, "default_narrative":{VALUE}, "originating_bank_account":{ "id":{VALUE}, "legacy_id":{VALUE}, "account_name":{VALUE}, "account_number":{VALUE}, "sort_code":{VALUE} }, "service_user_number":{ "id":{VALUE}, "sun_name":{VALUE}, "sun_number":{VALUE} }, "mandate":{ "id":{VALUE}, "auddis":{VALUE} } }, "card_payment":{VALUE} } ] }
Note: Property display order for documentation purposes, actual order may vary.
Recurrence Schedule Webhook - Structure
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
description | recurrence schedule cancelled |
status | inactive |
bacs_reason_code | AUDDISF |
bacs_description | invalid account type |
bacs_reference | XYZ0012345-0012345 |
bacs_filename | Auddis020419111111.xml |
{ "events": [ { "id" : {EVENTID}, "created_at" : {CREATEDDATE}, "resource_type": {RESOURCETYPE}, "event_source" : {EVENTSOURCE}, "reference" : {REFERENCE}, "auddis" : {AUDDIS} , "status" : {STATUS}, "description" : {DESCRIPTION}, "bacs_reason_code" : {BACSCODE}, "bacs_description" : {BACSDESCRIPTION}, "bacs_reference" : {BACSREFERENCE}, "bacs_filename" : {BACSFILENAME} } ] }
Recurrence Schedule Event - Structure
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
event_type | “recurrence_schedule.update” |
event_source | “DDMS service” |
status | “inactive” |
upcoming_payments | null |
bacs_reason_code | “AUDDISF” |
bacs_description | “invalid account type” |
bacs_reference | “XYZ0012345-0012345” |
bacs_filename | “Auddis020419111111.xml” |
{ "id":{VALUE}, "idempotency_key":{VALUE}, "sent_at":{VALUE}, "client":{ "id":{VALUE} }, "events":[ { "amount":{VALUE}, "description":{VALUE}, "created_at":{VALUE}, "id":{VALUE}, "event_id":{VALUE}, "edited_at":{VALUE}, "legacy_id":{VALUE}, "status":{VALUE}, "start_date":{VALUE}, "end_date":{VALUE}, "collection_period":{VALUE}, "collection_stretch":{VALUE}, "collection_day":{VALUE}, "next_collection_date":{VALUE}, "first_collection_amount":{VALUE}, "bacs_reason_code":{VALUE}, "bacs_description":{VALUE}, "first_collection_date":{VALUE}, "custom_reference":{VALUE}, "event_source":{VALUE}, "bacs_reference":{VALUE}, "bacs_filename":{VALUE}, "record_type":{VALUE}, "installments":{VALUE}, "total_value":{VALUE}, "payment_type":{VALUE}, "event_type":{VALUE}, "metadata":{VALUE}, "upcoming_payments":[ { "collection_date":{VALUE}, "amount":{VALUE} }, { "collection_date":{VALUE}, "amount":{VALUE} } ], "client":{ "id":{VALUE} }, "customer_account":{ "id":{VALUE}, "legacy_id":{VALUE} }, "card":{ "id":{VALUE}, "legacy_id":{VALUE} }, "mandate":{ "id":{VALUE}, "auddis":{VALUE} }, "bank_account":{ "id":{VALUE}, "legacy_id":{VALUE} } } ] }
Note: Property display order for documentation purposes, actual order may vary.
Bank Account Webhook - Structure
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
description | bank account disabled |
enabled | false |
bacs_reason_code | AUDDISF |
bacs_description | invalid account type |
bacs_reference | XYZ0012345-0012345 |
bacs_filename | Auddis020419111111.xml |
{ "events": [ { "id" : {EVENTID}, "bank_account" : {BANKACCOUNT}, "created_at" : {CREATEDDATE}, "resource_type": {BANKACCOUNT}, "description" : {DESCRIPTION}, "event_source": {EVENTSOURCE}, "account_number" : {ACCOUNTNUMBER}, "sort_code" : {SORTCODE}, "account_name" : {ACCOUNTNAME}, "currency" : {CURRENCY}, "enabled" : {ENABLED}, "bank_name" : {BANKNAME}, "customer_account" : {CUSTOMERACCOUNT}, "bacs_reason_code" : {BACSCODE}, "bacs_description" : {BACSDESCRIPTION}, "bacs_reference" : {BACSREFERENCE}, "bacs_filename" : {BACSFILENAME}, "custom_reference" : {CUSTOMREFERENCE} } ] }
Bank Account Event - Structure
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
event_type | “bank_account.update” |
event_source | “DDMS service” |
enabled | false |
bacs_reason_code | “AUDDISF” |
bacs_description | “invalid account type” |
bacs_reference | “XYZ0012345-0012345” |
bacs_filename | “Auddis020419111111.xml” |
{ "client":{ "id":{VALUE} }, "id":{VALUE}, "idempotency_key":{VALUE}, "sent_at":{VALUE}, "events":[ { "account_name":{VALUE}, "account_number":{VALUE}, "bacs_description":{VALUE}, "bacs_reason_code":{VALUE}, "bacs_reference":{VALUE}, "bacs_filename":{VALUE}, "bank_name":{VALUE}, "client":{ "id":{VALUE} }, "created_at":{VALUE}, "created_by":{ "id":{VALUE} }, "custom_reference":{VALUE}, "customer_account":{ "id":{VALUE}, "legacy_id":{VALUE} }, "edited_at":{VALUE}, "edited_by":{ "id":{VALUE} }, "enabled":{VALUE}, "event_source":{VALUE}, "event_type":{VALUE}, "id":{VALUE}, "event_id":{VALUE}, "legacy_id":{VALUE}, "currency_code":{VALUE}, "sort_code":{VALUE}, "metadata":{VALUE}, "debits_allowed":{VALUE}, "credits_allowed":{VALUE}, "Modulus_Check":{ "AccountNumber":{VALUE}, "AccountCodeOK":{VALUE}, "BankName":{VALUE}, "BranchAddress1":{VALUE}, "BranchAddress2":{VALUE}, "BranchAddress3":{VALUE}, "BranchAddress4":{VALUE}, "BranchAddressTown":{VALUE}, "BranchAddressPostCode":{VALUE}, "BranchTitle":{VALUE}, "CreditsAllowedOK":{VALUE} "DirectDebitsOK":{VALUE}, "DirectDebitInstructionOK":{VALUE}, "SortCode":{VALUE}, "SortCodeOK":{VALUE}, "TelephoneNumber":{VALUE}, } } ] }
Note: Property display order for documentation purposes, actual order may vary.
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
description | credit cancelled |
status | cancelled |
bacs_reason_code | AUDDISF |
bacs_description | invalid account type |
bacs_reference | XYZ0012345-0012345 |
bacs_filename | Auddis020419111111.xml |
{ "events": [ { "id" : {EVENTID} , "created_at" : {CREATEDDATE}, "resource_type": {RESOURCETYPE}, "event_source" : {EVENTSOURCE}, "reference" : {REFERENCE}, "status" : {STATUS}, "description" : {DESCRIPTION}, "bacs_reason_code" : {BACSCODE}, "bacs_description" : {BACSDESCRIPTION}, "bacs_reference" : {BACSREFERENCE}, "bacs_filename" : {BACSFILENAME}, "custom_reference" : {CUSTOMREFERENCE} } ] }
The fields that have been updated for this webhook are:
Field | Sample Value |
---|---|
event_type | “credit.update” |
event_source | “DDMS service” |
status | “cancelled” |
bacs_reason_code | “AUDDISF” |
bacs_description | “invalid account type” |
bacs_reference | “XYZ0012345-0012345” |
bacs_filename | “Addacs020419111111” |
{ "id":{VALUE}, "idempotency_key":{VALUE}, "sent_at":{VALUE}, "client": { "id":{VALUE} }, "events":[ { "id":{VALUE}, "event_id":{VALUE}, "legacy_id":{VALUE}, "amount":{VALUE}, "credit_date":{VALUE}, "created_at":{VALUE}, "status":{VALUE}, "edited_by_id":{VALUE}, "submission_reference":{VALUE}, "edited_at":{VALUE}, "description":{VALUE}, "custom_reference":{VALUE}, "event_type":{VALUE}, "event_source":{VALUE}, "overriding_name":{VALUE}, "default_narrative":{VALUE}, "rti":{VALUE}, "bacs_reason_code":{VALUE}, "bacs_description":{VALUE}, "bacs_reference":{VALUE}, "bacs_filename":{VALUE}, "metadata":{VALUE}, "created_by":{ "id":{VALUE} }, "edited_by":{ "id":{VALUE} }, "customer_account":{ "id":{VALUE}, "legacy_id":{VALUE} }, "bank_account":{ "id":{VALUE}, "legacy_id":{VALUE}, "account_name": {VALUE}, "account_number": {VALUE}, "sort_code": {VALUE}, "bank_name": {VALUE} }, "mandate":{ "id":{VALUE}, "auddis":{VALUE} }, "originating_bank_account":{ "id":{VALUE}, "legacy_id":{VALUE}, "account_name":{VALUE}, "account_number":{VALUE}, "sort_code":{VALUE} }, "service_user_number":{ "id":{VALUE}, "sun_name":{VALUE}, "sun_number":{VALUE} }, "client":{ "id":{VALUE} } } ] }
Note: Property display order for documentation purposes, actual order may vary.