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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA1” |
| bacs_description | “amount and or date of dd differs” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
{
"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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA2” |
| bacs_description | “no advance notice received” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
{
"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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA3” |
| bacs_description | “ddi cancelled by paying bank” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
| 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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA4” |
| bacs_description | “payer has cancelled ddi direct with service user” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
| 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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA5” |
| bacs_description | “no instruction held” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
| 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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA6” |
| bacs_description | “signature on ddi is fraudulent” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
| 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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA7” |
| bacs_description | “claim raised at service users request” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
{
"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},
"paying_bank_reference":{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 | “indemnity_claimed” |
| bacs_reason_code | “DDICA8” |
| bacs_description | “service user name disputed” |
| bacs_reference | “XYZ0012345-0012345” |
| bacs_filename | “Ddica020419111111.xml” |
| paying_bank_reference | “DDICA2510141205” |
| 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},
"paying_bank_reference":{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 |
|---|---|
| status | failed |
| bacs_description | Approval expired |
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Approval rejected |
| Field | Sample Value |
|---|---|
| status | successful |
| bacs_description | Challenge accepted |
| Field | Sample Value |
|---|---|
| status | successful |
| bacs_description | Challenge auto accepted |
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Challenge expired |
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Challenge rejected |
| Field | Sample Value |
|---|---|
| status | failed |
| bacs_description | Challenge withdrawn |
| Field | Sample Value |
|---|---|
| bacs_description | PSP reviewing |
| Field | Sample Value |
|---|---|
| bacs_description | Pending PSP review |
| Field | Sample Value |
|---|---|
| bacs_description | Pending approval |
| 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},
"paying_bank_reference":{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.