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}, "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 | “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}, "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.