Direct Debit Payment Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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 - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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 - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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 - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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 - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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 - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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 - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_type | “payment.update” |
| event_source | “DDMS service” |
| status | “cancelled” |
| bacs_reason_code | “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},
"users_reference":{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.