Payment_disputed webhook
You receive this webhook when a indemnity claim has been made against a payment. This currently only applies to payments made via direct debit mandates.
The following table includes the fields that appear in the payment_disputed notification:
| Field | Type | Optional | Description |
|---|---|---|---|
type | string | No | Type of the event ("payment_disputed") |
event_version | integer | No | A UUID for the event |
event_id | string | No | The version of the event schema |
payment_id | string | No | The unique ID for the original payment |
metadata | object | No | A set of key-value pairs of custom data that was provided when the payment was created |
disputed_at | datetime | No | An RFC-3339 timestamp of when the payment was authorized |
disputed_reason | string | Yes | The reason the payment was disputed. |
expires_at | datetime | No | The date and time that the dispute will expire and, by default, be resolved in favour of the end user. |
{
"type": "payment_disputed",
"event_version": 1,
"metadata": {
"newKey": "New Value"
},
"payment_method": {
"type": "bank_transfer"
},
"event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
"payment_id": "0afd1f6a-f611-48ce-9488-321129bb3a70",
"disputed_at": "2023-06-13T15:00:00.000Z",
"disputed_reason": "example_reason",
"expires_at": "2025-09-02T00:00:00.000Z"
}
The following reasons can occur in the disputed_reason field:
| Dispute reason |
|---|
| advance_notice_disputed |
| beneficiary_account_holder_name_disputed |
| client_requested |
| mandate_disputed |
| mandate_revoked |
| no_advance_notice |
| unknown |
Updated about 1 month ago