Skip to content
/
Mandate Failed

Mandate Failed
Webhook

Request

Triggered when a mandate could not be created or activated.

Headers
X-Webhook-Signaturestring(X-Webhook-Signature)required

HMAC-SHA256 signature of the request body using your webhook secret.

Bodyapplication/jsonrequired
event_idstring(Event Id)required

Unique event identifier

timestampstring, (date-time)(Timestamp)required

Event timestamp

sponsor_idstring(Sponsor Id)required

Sponsor ID

event_typestring(Event Type)required
Value:"mandate.failed"
dataobject(MandateFailedData)required

Data payload for mandate.failed webhook event.

Payload
{
  "event_id": "evt_abc123def456",
  "timestamp": "2019-08-24T14:15:22Z",
  "sponsor_id": "sandbox-1234/5678",
  "event_type": "mandate.failed",
  "data": {
    "mandate_id": "mdt_abc123def456",
    "client_id": "client_xyz789",
    "error_cause": "mandate rejected by PPF"
  }
}

Responses

Successful Response

Bodyapplication/json
any
Response
// No response example