A payout can fail for a variety of reasons — such as invalid recipient details, closed bank accounts, or compliance issues. When a payout fails, Acclaim updates its status, notifies you via webhook, and automatically returns the funds to the funding account. Your system should be designed to listen for these events, update records, and, if appropriate, reissue the payout once the issue is corrected.Documentation Index
Fetch the complete documentation index at: https://docs.withacclaim.com/llms.txt
Use this file to discover all available pages before exploring further.
Common Causes
Payout failures can happen for several reasons:- Incorrect payee details — wrong account number, routing number, or payment method.
- Closed or restricted accounts — the recipient’s bank rejected the payment.
- Insufficient account balance — not enough funds were available at the time of execution.
- Currency or jurisdiction mismatch — the payment route was not supported for the destination country or currency.
- Compliance or sanctions hold — payment blocked due to screening requirements.
Detecting Failures
You can detect failed payouts through several channels:- Webhooks: Subscribe to the
payout.failedevent to receive instant notification when a payout cannot be completed. - API: Retrieve a payout by ID and inspect the
statusfield — it will showfailed. - Console: View detailed failure reasons, timestamps, and related account adjustments in the Acclaim Console.
Resolving Failed Payouts
When a payout fails:- Review the failure reason — check the
failure_codeandfailure_messagefields. - Correct the issue — update payee information, verify account balance, or contact your banking team if necessary.
- Reissue the payout — create a new payout once the issue is resolved.
Webhook Events
Important events to handle when managing failed payouts:| Event | Description |
|---|---|
payout.failed | A payout could not be completed. |
treasury.transaction.created | A payout reversal transaction was created. |
Best Practices
- Ensure accounts remain adequately funded before initiating large batches.
- Implement webhook listeners to handle failures automatically.
- Avoid retrying the same payout ID; always create a new one after correction.