Payout_attempt_failed webhook
You receive this webhook when an attempted payout fails, but will be retried. Payouts made over the SEPA Instant scheme may be rerouted to another scheme. This applies to payouts to external accounts as well as sweeping payouts to your business account.
The new payout_attempt_failed webhook provides real-time visibility into:
- When a payout attempt fails but will be retried
- When the next retry will occur
- Whether the payout will reroute to a different payment scheme
- How many retries remain
This allows you to proactively inform end users about potential delays to their payouts, for example with UI messages.
In addition, payouts made with the SEPA Instant scheme will automatically reroute to the SEPA Credit scheme on the final attempt.
The webhook that you receive when a retry attempt fails looks like this:
{
"type": "payout_attempt_failed",
"event_id": "b8d4dda0-ff2c-4d77-a6da-4615e4bad941",
"payout_id": "0cd1b0f7-71bc-4d24-b209-95259dadcc20",
"delayed_at": "2021-12-25T15:00:00.000Z",
"beneficiary": { ... },
"scheme_id": "faster_payments_service",
"metadata": { ... },
"retry": {
"next_attempt_at": "2021-12-25T16:00:00.000Z",
"attempt_count": 2,
"attempts_remaining": 3,
"scheduled_for_rerouting": false
}
}| Field | Type | Description |
|---|---|---|
type | string | Type of the event. In this case, it would be: payout_attempt_failed |
event_id | string | The UUID of that specific event. |
payout_id | string | UUID of the payout for which the webhook is being sent |
delayed_at | string | Timestamp of the event, in ISO8601 format |
beneficiary.type | string | Value would be This indicates that the payout is made to the |
beneficiary.payment_source_id | string | ID of the external account which has become a payment source. |
beneficiary.user_id | string | ID of the user that owns the external account. |
scheme_id | string | The id of the scheme used to execute the payout. Possible values are:
|
retry.next_attempt_at | string | A timestamp in ISO8601 format for the next time the payout will be retried, after this one. |
retry.attempt_count | number | The number of times that this payout has been retried. |
retry.attempts_remaining | number | The number of retries left before the payout expires. |
retry.scheduled_for_rerouting | boolean | Whether the payment is going to be rerouted to a different scheme on the next attempt. For Faster Payment Service payouts, this value will always be |
metadata | string | Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a maximum key length of 40 characters and a maximum value length of 500 characters. |
Updated about 2 hours ago
