Payment Event
Event structure and samples for Payments.
Payment Event - Structure
Card Payment Event - Structure
Note: Version 2 Webhooks can contain more that one event per webhook. Please see “V2 Webhook Structure” for more details.
Event Fields
| Property | Format | Description |
|---|---|---|
| amount | integer | The amount of the payment in pence |
| card_payment | Object or null | Object containing the card_payment information. See below |
| client | Object | Object containing the client information. See below |
| collection_date | date (YYYY-MM-DD) | The Collection Date of the Payment |
| created_at | datetime (ISO8601) | Date and time the record was created |
| created_by | Object or null | Object containing the created_by information, if set. See below |
| currency_code | string (ISO4217) | ISO 4217 representation of the currency used for the payment |
| custom_reference | string or null | The Custom reference, if set |
| customer_account | object or null | Object containing Customer Account information, if set. See below |
| description | string | The Payments description |
| direct_debit | null | null - Not applicable to Card Payment Events |
| edited_at | datetime (ISO8601) | Date and time the record was edited |
| edited_by | object or null | Object containing the created_by information, if set. See below |
| event_id | string | The ID of the Event |
| event_source | string | The Source that triggered the event |
| event_type | string | This will be “payment.create” or “payment.update” |
| id | string | The ID of the Record |
| legacy_id | string or null | Legacy ID of the record, if set |
| metadata | string or null | String used to store custom metadata, if set |
| mandate | null | null - Not applicable to Card Payment Events |
| payment_type | string | The payment type of the record. See “Property Options” below |
| record_type | string | The record type of the Payment. See “Property Options” below |
| recurrence_schedule | Object or null | Object containing the recurrence_schedule information, if set. See below |
| related_payment | Object or null | Object containing the related_payment information, if set. See below |
| represented_collection_date | date (YYYY-MM-DD) | Date the represented was collected, if set |
| status | string | The Status of the Payment. See “Property Options” below |
client Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
created_by Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
customer_account Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
| legacy_id | string or null | Legacy ID of the record, if set |
edited_by Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
recurrence_schedule Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | The ID of the Record |
| legacy_id | string | Legacy ID of the record, if set |
related_payment Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | The ID of the Record |
| legacy_id | string | Legacy ID of the record, if set |
card_payment Object Fields
| Property | Format | Description |
|---|---|---|
| authorisation_code | string or null | Payment Authorisation code, if set |
| card | object | Object containing the card information. See below |
| charge_id | string or null | Charge ID, if set |
| gateway_payment_description | string or null | Gateway payment description, if set |
| gateway_status | string or null | The status of the card passed by the gateway to SmarterPay, if set |
| gateway_status_code | string or null | A code that the gateway may pass to SmarterPay to further describe the status, if set |
| gateway_status_details | string or null | Additional information, based on the status, passed by the gateway to SmarterPay, if set |
| internal_payment_description | string or null | Internal payment description, if set |
| metadata | string or null | Additional client JSON initially passed in the card registration request, if set |
| order_id | string or null | Order ID, if set |
| status_code | string or null | SmarterPay's normalised status code of the card, if set |
| status_details | string or null | SmarterPay's additional information based on the status, if set |
| transaction_id | string or null | Payment Transaction ID, if set |
card Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
| legacy_id | string or null | Legacy ID of the record, if set |
{
"id":{VALUE},
"idempotency_key":{VALUE},
"sent_at":{VALUE},
"client":{
"id":{VALUE}
},
"events":[
{
"id":{VALUE},
"event_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},
"direct_debit":{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}
},
"card_payment":{
"status_details":{VALUE},
"status_code":{VALUE},
"internal_payment_description":{VALUE},
"gateway_payment_description":{VALUE},
"authorisation_code":{VALUE},
"transaction_id":{VALUE},
"order_id":{VALUE},
"charge_id":{VALUE},
"metadata":{VALUE},
"gateway_status":{VALUE},
"gateway_status_code":{VALUE},
"gateway_status_details":{VALUE},
"card"{
"id":{VALUE},
"legacy_id":{VALUE}
}
}
}
]
}
Note: Property display order for documentation purposes, actual order may vary.
Direct Debit Payment Event - Structure
Note: Version 2 Webhooks can contain more that one event per webhook. Please see “V2 Webhook Structure” for more details.
Event Fields
| Property | Format | Description |
|---|---|---|
| amount | integer | The amount of the payment in pence |
| card_payment | null | null - Not applicable to Direct Debit Payment Events |
| client | Object | Object containing the client information. See below |
| collection_date | date (YYYY-MM-DD) | The Collection Date of the Payment |
| created_at | datetime (ISO8601) | Date and time the record was created |
| created_by | Object or null | Object containing the created_by information, if set. See below |
| custom_reference | string or null | The Custom reference,if set |
| customer_account | object or null | Object containing Customer Account information, if set. See below |
| description | string | The Payments description |
| direct_debit | Object | Object containing the direct_debit information. See below |
| edited_at | datetime (ISO8601) | Date and time the record was edited |
| edited_by | object or null | Object containing the created_by information, if set. See below |
| event_source | string | The Source that triggered the event |
| event_type | string | This will be “payment.create” or “payment.update” |
| id | string | The ID of the Record |
| legacy_id | string or null | Legacy ID of the record, if set |
| metadata | string or null | String used to store custom metadata, if set |
| mandate | Object or null | Object containing the mandate information, if set. See below |
| payment_type | string | The payment type of the record. See “Property Options” below |
| record_type | string | The record type of the Payment. See “Property Options” below |
| recurrence_schedule | Object or null | Object containing the recurrence_schedule information, if set. See below |
| related_payment | Object or null | Object containing the related_payment information, if set. See below |
| represented_collection_date | date (YYYY-MM-DD) | Date the represented was collected, if set |
| status | string | The Status of the Payment. See “Property Options” below |
client Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
created_by Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
customer_account Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
| legacy_id | string or null | Legacy ID of the record, if set |
edited_by Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | ID of the record |
recurrence_schedule Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | The ID of the Record |
| legacy_id | string | Legacy ID of the record, if set |
related_payment Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | The ID of the Record |
| legacy_id | string | Legacy ID of the record, if set |
direct_debit Object Fields
| Property | Format | Description |
|---|---|---|
| bacs_description | string or null | The BACS Rejection Description, if set |
| bacs_filename | string or null | The BACS Rejection File Name, if set |
| bacs_reason_code | string or null | The BACS Rejection Reason Code, if set |
| bacs_reference | string or null | The BACS Reference, if set |
| default_narrative | string or null | Payments default narrative, if set |
| mandate | object | Object containing the mandate information. See below |
| originating_bank_account | object | Object containing the originating_bank_account information. See below |
| overriding_name | string or null | Payment overriding name, if set |
| service_user_number | object | Object containing the service_user_number information. See below |
mandate Object Fields
| Property | Format | Description |
|---|---|---|
| auddis | string | The Mandate/AUDDIS Reference of the Mandate |
| id | string | The ID of the Record |
originating_bank_account Object Fields
| Property | Format | Description |
|---|---|---|
| account_name | string | Account holder name |
| account_number | string | Account number |
| bank_name | string | Bank name |
| id | string | ID of the record |
| legacy_id | string or null | Legacy ID of the record, if set |
| sort_code | string | Sort code |
service_user_number Object Fields
| Property | Format | Description |
|---|---|---|
| id | string | The ID of the Record |
| sun_name | string | Friendly name for the service user number |
| sun_number | string | Service user number |
{
"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.
Notes:
- Properties displayed in alphabetical order for documentation purposes, actual order will vary.
Property Options
| Property | Possible Values |
|---|---|
| payment_type | Ecommerce |
| first collection | |
| MOTO | |
| ongoing collection | |
| Repeat | |
| record_type | card_payment |
| direct_debit | |
| status | cancelled |
| failed | |
| indemnity_claimed | |
| pending_submission | |
| submitted | |
| successful |
Payment Event - Samples
Card Payment Event - Sample - General
Card Payment Event - Sample - Record Creation
Card Payment Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| id | “P01MD1LRPMMV14PYEQG” |
| event_id | “HI05137EJ74XZY6J4QOM” |
| legacy_id | null |
| created_at | “2024-04-09T09:38:56Z” |
| collection_date | “2024-04-09” |
| amount | 2750 |
| payment_type | “MOTO” |
| currency_code | “GBP” |
| status | “successful” |
| edited_at | “2024-04-09T09:38:56Z” |
| represented_collection_date | null |
| custom_reference | null |
| event_source | “API” |
| record_type | “card_payment” |
| description | “Payment” |
| event_type | “payment.create” |
| metadata | null |
| client:id | “CL01LG420EJ9DP1VQWR9” |
| created_by | null |
| edited_by | null |
| customer_account:id | “CA01ZO41Y8DZ19P0GNLW” |
| customer_account:legacy_id | null |
| recurrence_schedule | null |
| related_payment | null |
| direct_debit | null |
| card_payment:status_details | null |
| card_payment:status_code | null |
| card_payment:internal_payment_description | null |
| card_payment:gateway_payment_description | null |
| card_payment:authorisation_code | “21770393” |
| card_payment:transaction_id | “20CEEA1D-0FCD-22FD-201D-B69BB78DB617” |
| card_payment:order_id | null |
| card_payment:charge_id | “CD0175OW1YJVQK8X29LV_1712651935” |
| card_payment:gateway_status | “Ok” |
| card_payment:gateway_status_code | “0000” |
| card_payment:gateway_status_details | “The Authorisation was Successful.” |
| card_payment:card:id | “CD0175OW1YJVQK8X29LV” |
| card_payment:card:legacy_id | null |
{
"id":{VALUE},
"idempotency_key":{VALUE},
"sent_at":{VALUE},
"client":{
"id":{VALUE}
},
"events":[
{
"id":{VALUE},
"event_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},
"direct_debit":{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}
},
"card_payment":{
"status_details":{VALUE},
"status_code":{VALUE},
"internal_payment_description":{VALUE},
"gateway_payment_description":{VALUE},
"authorisation_code":{VALUE},
"transaction_id":{VALUE},
"order_id":{VALUE},
"charge_id":{VALUE},
"metadata":{VALUE},
"gateway_status":{VALUE},
"gateway_status_code":{VALUE},
"gateway_status_details":{VALUE},
"card"{
"id":{VALUE},
"legacy_id":{VALUE}
}
}
}
]
}
Note: Property display order for documentation purposes, actual order may vary.
Direct Debit Payment Event - Sample - General
Direct Debit Payment Event - Sample - Record Creation
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| id | “P01OW1YJVZ5VDY8X29L” |
| event_id | “HI05RM9OPEK1M7DP024D” |
| legacy_id | null |
| created_at | “2024-04-16T13:37:32Z” |
| collection_date | “2024-04-18” |
| amount | 1337 |
| payment_type | “first collection” |
| currency_code | “GBP” |
| status | “pending_submission” |
| edited_at | “2024-04-16T13:37:32Z” |
| represented_collection_date | null |
| custom_reference | “” |
| event_source | “Portal” |
| record_type | “direct_debit” |
| description | “Test” |
| event_type | “payment.create” |
| metadata | null |
| client:id | “CL01LG420EJ9DP1VQWR9” |
| created_by:id | “CU01LG420EJ9VWP1VQWR” |
| edited_by | null |
| customer_account:id | “CA01WZQ0583EW986KNOE” |
| customer_account:legacy_id | null |
| recurrence_schedule | null |
| related_payment | null |
| direct_debit:bacs_reference | null |
| direct_debit:bacs_filename | null |
| direct_debit:bacs_reason_code | null |
| direct_debit:bacs_description | null |
| direct_debit:overriding_name | null |
| direct_debit:default_narrative | “” |
| direct_debit:originating_bank_account:id | “OB01O6YQRDJZWJVL359M” |
| direct_debit:originating_bank_account:legacy_id | “CBA-0000002” |
| direct_debit:originating_bank_account:account_name | “CBA - FTB - 01” |
| direct_debit:originating_bank_account:account_number | “10020645” |
| direct_debit:originating_bank_account:sort_code | “834600” |
| direct_debit:service_user_number:id | “SN019LVZMGJ2KD8K46WE” |
| direct_debit:service_user_number:sun_number | “100263” |
| direct_debit:service_user_number:sun_name | “Smarterpay Test” |
| direct_debit:mandate:id | “M01NWLOKJYKOV38RX5Q” |
| direct_debit:mandate:auddis | “F05AR37M00000004” |
| card_payment | null |
{
"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.
Direct Debit Payment Event - Sample - Record Update
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| status | “successful” |
| edited_at | “2024-04-24T07:00:00Z” |
| event_source | “DDMS Service” |
| event_type | “payment.update” |
| edited_by | null |
{
"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.
Direct Debit Payment Event - Sample - BACS rejection codes - ADDACS
Direct Debit Payment Event - Sample - Rejection Report - ADDACS 0
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACS0” |
| bacs_description | “instruction cancelled - refer to payer” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ADDACS 1
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACS1” |
| bacs_description | “instruction cancelled by payer” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ADDACS 2
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACS2” |
| bacs_description | “payer deceased” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ADDACS 3
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACS3” |
| bacs_description | “instruction cancelled, account transferred” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ADDACS B
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACSB” |
| bacs_description | “account closed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ADDACS D
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACSD” |
| bacs_description | “advance notice disputed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ADDACS R
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ADDACSR” |
| bacs_description | “instruction reinstated” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Addacs020419111111.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.
Direct Debit Payment Event - Sample - BACS rejection codes - ARUDD
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 0
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD0” |
| bacs_description | “refer to payer” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 1
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD1” |
| bacs_description | “instruction cancelled” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDD1” |
| bacs_description | “instruction cancelled” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 2
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD2” |
| bacs_description | “payer deceased” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDD2” |
| bacs_description | “payer deceased” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 3
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD3” |
| bacs_description | “account transferred” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDD3” |
| bacs_description | “account transferred” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 4
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD4” |
| bacs_description | “advance notice disputed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 5
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD5” |
| bacs_description | “no account (or wrong account type)” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDD5” |
| bacs_description | “no account (or wrong account type)” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 6
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD6” |
| bacs_description | “no instruction” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDD6” |
| bacs_description | “no instruction” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 7
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD7” |
| bacs_description | “amount differs” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 8
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD8” |
| bacs_description | “amount not yet due” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD 9
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDD9” |
| bacs_description | “presentation overdue” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD A
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDDA” |
| bacs_description | “service user differs” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDDA” |
| bacs_description | “service user differs” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ARUDD B
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “ARUDDB” |
| bacs_description | “account closed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “ARUDDB” |
| bacs_description | “account closed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Arudd020419111111.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.
Direct Debit Payment Event - Sample - BACS rejection codes - AUDDIS
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS 1
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDIS1” |
| bacs_description | “instruction cancelled by payer” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS 2
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDIS2” |
| bacs_description | “payer deceased” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS 3
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDIS3” |
| bacs_description | “instruction cancelled, account transferred” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS 5
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDIS5” |
| bacs_description | “no account” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS 6
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDIS6” |
| bacs_description | “no instruction” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS B
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISB” |
| bacs_description | “account closed” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS F
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS G
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISG” |
| bacs_description | “bank will not accept direct debits on account” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS H
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISH” |
| bacs_description | “instruction expired” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS I
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISI” |
| bacs_description | “payer reference is not unique” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS K
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISK” |
| bacs_description | “instruction cancelled by bank” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS L
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISL” |
| bacs_description | “incorrect payers account details” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS M
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISM” |
| bacs_description | “transaction code/user status incompatible” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS N
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISN” |
| bacs_description | “transaction disallowed at payers branch” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS O
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISO” |
| bacs_description | “invalid reference” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS P
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISP” |
| bacs_description | “payers name not present” |
| 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.
Direct Debit Payment Event - Sample - Rejection Report - AUDDIS Q
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “AUDDISQ” |
| bacs_description | “service username is blank” |
| 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.
Direct Debit Payment Event - Sample - BACS rejection codes - DDICA
Direct Debit Payment Event - Sample - Rejection Report - DDICA 1
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA1” |
| bacs_description | “amount and or date of dd differs” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 2
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA2” |
| bacs_description | “no advance notice received” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 3
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA3” |
| bacs_description | “ddi cancelled by paying bank” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “DDICA3” |
| bacs_description | “ddi cancelled by paying bank” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 4
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA4” |
| bacs_description | “payer has cancelled ddi direct with service user” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “DDICA4” |
| bacs_description | “payer has cancelled ddi direct with service user” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 5
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA5” |
| bacs_description | “no instruction held” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “DDICA5” |
| bacs_description | “no instruction held” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 6
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA6” |
| bacs_description | “signature on ddi is fraudulent” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “DDICA6” |
| bacs_description | “signature on ddi is fraudulent” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 7
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA7” |
| bacs_description | “claim raised at service users request” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - DDICA 8
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Rejection
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “indemnity_claimed” |
| bacs_reason_code | “DDICA8” |
| bacs_description | “service user name disputed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “DDICA8” |
| bacs_description | “service user name disputed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.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.
Direct Debit Payment Event - Sample - Rejection Report - ddica_challenge
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Report Status: "Approval expired"
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Approval expired |
Report Status: "Approval rejected"
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Approval rejected |
Report Status: "Challenge accepted"
| Field | Sample Value |
|---|---|
| status | successful |
| bacs_description | Challenge accepted |
Report Status: "Challenge auto accepted"
| Field | Sample Value |
|---|---|
| status | successful |
| bacs_description | Challenge auto accepted |
Report Status: "Challenge expired"
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Challenge expired |
Report Status: "Challenge rejected"
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Challenge rejected |
Report Status: "Challenge withdrawn"
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Challenge withdrawn |
Report Status: "PSP reviewing"
| Field | Sample Value |
|---|---|
| bacs_description | PSP reviewing |
Report Status: "Pending PSP review"
| Field | Sample Value |
|---|---|
| bacs_description | Pending PSP review |
Report Status: "Pending approval"
| Field | Sample Value |
|---|---|
| bacs_description | Pending approval |
Report Status: "SUN reviewing challenge"
| Field | Sample Value |
|---|---|
| bacs_description | SUN reviewing challenge |
{
"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.
Direct Debit Payment Event - Sample - Input Reports
Direct Debit Payment Event - Sample - Input Reports - INPUT C
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTC” |
| bacs_description | “destination sorting code and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTC” |
| bacs_description | “destination sorting code and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT D
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTD” |
| bacs_description | “destination sorting code and orginating account number were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTD” |
| bacs_description | “destination sorting code and orginating account number were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT E
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTE” |
| bacs_description | “recipients sort code is invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTE” |
| bacs_description | “recipients sort code is invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT F
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTF” |
| bacs_description | “type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTF” |
| bacs_description | “type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT G
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTG” |
| bacs_description | “type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTG” |
| bacs_description | “type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT H
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTH” |
| bacs_description | “destination sorting code and type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTH” |
| bacs_description | “destination sorting code and type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT I
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTI” |
| bacs_description | “destination sorting code and type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTI” |
| bacs_description | “destination sorting code and type of account and originating sorting code were invalid on the item” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT J
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTJ” |
| bacs_description | “destination sorting code and type of account were invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTJ” |
| bacs_description | “destination sorting code and type of account were invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT K
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTK” |
| bacs_description | “type of account was invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTK” |
| bacs_description | “type of account was invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT L
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTL” |
| bacs_description | “Multiple fields including destination account number and destination account name were invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTL” |
| bacs_description | “Multiple fields including destination account number and destination account name were invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT M
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTM” |
| bacs_description | “destination account number and destination account name were invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTM” |
| bacs_description | “destination account number and destination account name were invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT O
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTO” |
| bacs_description | “reference number was invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTO” |
| bacs_description | “reference number was invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT P
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTP” |
| bacs_description | “The originating account is valid but the originating account does not support the currency of the file” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTP” |
| bacs_description | “The originating account is valid but the originating account does not support the currency of the file” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT T
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTT” |
| bacs_description | “Originator Account details are invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTT” |
| bacs_description | “Originator Account details are invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT U
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTU” |
| bacs_description | “unpaid Direct Debit reference was in error” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTU” |
| bacs_description | “unpaid Direct Debit reference was in error” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT X
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTX” |
| bacs_description | “originator’s service user number was invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTX” |
| bacs_description | “originator’s service user number was invalid” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT Y
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTY” |
| bacs_description | “transaction code unacceptable for destination sort code” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTY” |
| bacs_description | “transaction code unacceptable for destination sort code” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.
Direct Debit Payment Event - Sample - Input Reports - INPUT Z
Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
Submitted Payment that triggered the Input Report
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “failed” |
| bacs_reason_code | “INPUTZ” |
| bacs_description | “unpaid Direct Debit reference and other fields were in error” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.xml” |
Future Pending Payments
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “INPUTZ” |
| bacs_description | “unpaid Direct Debit reference and other fields were in error” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “ReftInput020822080046.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.