Recurrence Schedule Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| amount | 15000 |
| description | “payment plan” |
| created_at | “2024-09-16T09:52:55Z” |
| id | “RS01YR6K8KNKOR2Y84ZL” |
| event_id | “HI077ZGLJLY6WXWE8W53” |
| legacy_id | null |
| status | “active” |
| start_date | “2024-09-23” |
| end_date | “2024-12-23” |
| collection_period | “monthly” |
| collection_stretch | 1 |
| collection_day | “23” |
| next_collection_date | “2024-09-23” |
| first_collection_amount | 3750 |
| bacs_reason_code | null |
| bacs_description | null |
| first_collection_date | “2024-09-23” |
| custom_reference | null |
| event_source | “Portal” |
| bacs_reference | null |
| bacs_filename | null |
| record_type | “DDPaymentPlan” |
| installments | 4 |
| total_value | 0 |
| payment_type | “directdebit” |
| event_type | “recurrence_schedule.create” |
| edited_at | “2024-09-16T09:52:55Z” |
| metadata | null |
| upcoming_payments | [{“collection_date”: “2024-09-23”,“amount”: 3750},{“collection_date”: “2024-10-23”,“amount”: 3750},{“collection_date”: “2024-11-25”,“amount”: 3750},{“collection_date”: “2024-12-23”,“amount”: 3750}] |
| client:id | “CL01KO5D0G80GYJERW4V” |
| created_by | null |
| edited_by | null |
| customer_account:id | “CA01VQY3LJOE3MQPE61O” |
| customer_account:legacy_id | null |
| bank_account:id | “BA01ZQ0583320WN186KN” |
| bank_account:legacy_id | null |
| mandate:id | “M01O41Y8DOQ369MJ0GN” |
| mandate:auddis | “MA10144749” |
| card | null |
{
"id":{VALUE},
"idempotency_key":{VALUE},
"sent_at":{VALUE},
"client":{
"id":{VALUE}
},
"events":[
{
"amount":{VALUE},
"description":{VALUE},
"created_at":{VALUE},
"id":{VALUE},
"event_id":{VALUE},
"edited_at":{VALUE},
"legacy_id":{VALUE},
"status":{VALUE},
"start_date":{VALUE},
"end_date":{VALUE},
"collection_period":{VALUE},
"collection_stretch":{VALUE},
"collection_day":{VALUE},
"next_collection_date":{VALUE},
"first_collection_amount":{VALUE},
"bacs_reason_code":{VALUE},
"bacs_description":{VALUE},
"first_collection_date":{VALUE},
"custom_reference":{VALUE},
"event_source":{VALUE},
"bacs_reference":{VALUE},
"bacs_filename":{VALUE},
"record_type":{VALUE},
"installments":{VALUE},
"total_value":{VALUE},
"payment_type":{VALUE},
"event_type":{VALUE},
"metadata":{VALUE},
"upcoming_payments":[
{
"collection_date":{VALUE},
"amount":{VALUE}
},
{
"collection_date":{VALUE},
"amount":{VALUE}
}
],
"client":{
"id":{VALUE}
},
"customer_account":{
"id":{VALUE},
"legacy_id":{VALUE}
},
"card":{
"id":{VALUE},
"legacy_id":{VALUE}
},
"mandate":{
"id":{VALUE},
"auddis":{VALUE}
},
"bank_account":{
"id":{VALUE},
"legacy_id":{VALUE}
}
}
]
}
Note: Property display order for documentation purposes, actual order may vary.
Recurrence Schedule Event - Structure
The fields that have been updated for this webhook are:
| Field | Sample Value |
|---|---|
| event_id | “HI07YZ96J1D41YG48NEW” |
| next_collection_date | “2024-10-23” |
| event_source | “DDMS Service” |
| event_type | “recurrence_schedule.update” |
| edited_at | “2024-09-19T00:15:40Z” |
| upcoming_payments | {“collection_date”: “2024-10-23”,“amount”: 3750},{“collection_date”: “2024-11-25”,“amount”: 3750},{“collection_date”: “2024-12-23”,“amount”: 3750}] |
{
"id":{VALUE},
"idempotency_key":{VALUE},
"sent_at":{VALUE},
"client":{
"id":{VALUE}
},
"events":[
{
"amount":{VALUE},
"description":{VALUE},
"created_at":{VALUE},
"id":{VALUE},
"event_id":{VALUE},
"edited_at":{VALUE},
"legacy_id":{VALUE},
"status":{VALUE},
"start_date":{VALUE},
"end_date":{VALUE},
"collection_period":{VALUE},
"collection_stretch":{VALUE},
"collection_day":{VALUE},
"next_collection_date":{VALUE},
"first_collection_amount":{VALUE},
"bacs_reason_code":{VALUE},
"bacs_description":{VALUE},
"first_collection_date":{VALUE},
"custom_reference":{VALUE},
"event_source":{VALUE},
"bacs_reference":{VALUE},
"bacs_filename":{VALUE},
"record_type":{VALUE},
"installments":{VALUE},
"total_value":{VALUE},
"payment_type":{VALUE},
"event_type":{VALUE},
"metadata":{VALUE},
"upcoming_payments":[
{
"collection_date":{VALUE},
"amount":{VALUE}
},
{
"collection_date":{VALUE},
"amount":{VALUE}
}
],
"client":{
"id":{VALUE}
},
"customer_account":{
"id":{VALUE},
"legacy_id":{VALUE}
},
"card":{
"id":{VALUE},
"legacy_id":{VALUE}
},
"mandate":{
"id":{VALUE},
"auddis":{VALUE}
},
"bank_account":{
"id":{VALUE},
"legacy_id":{VALUE}
}
}
]
}
Note: Property display order for documentation purposes, actual order may vary.