Skip to content

Payout status

A payout transitions through several states between creation and final outcome. This page lists all possible statuses and the logical transitions between them.

Statuses

StatusDescription
initiatedThe payout has been created and sent to the aggregator. Waiting for processing to begin.
pendingThe aggregator has accepted the payout and is executing it. No action required on your side.
successThe recipient has received the funds. This is the final positive state.
failedThe payout could not be completed. The failure_reason field details the cause.
cancelledThe payout was cancelled before execution (manually or by the aggregator).

Transition diagram

initiated ──> pending ──> success
                   └────> failed
                   └────> cancelled

A payout never returns to an earlier state. Once success, failed or cancelled, it is immutable.

Common failure causes

The failure_reason field provides a human-readable text explaining the failure. The most frequent reasons:

ReasonDescription
Insufficient fundsYour Zayono balance or the aggregator's balance is insufficient
Invalid recipient numberThe recipient's phone number is invalid or not registered
Recipient account inactiveThe recipient's mobile money account is not active
Operator unavailableTemporary unavailability of the operator's network
Amount limit exceededThe amount exceeds daily or monthly limits

Best practices

  • Never deliver the service on any status other than success
  • Log failure_reason for your own dashboards and customer support
  • Retry failed payouts only if the cause is temporary (operator network unavailable)
  • For payouts stuck in pending for over 24 hours, contact support

Official Zayono API documentation