Payout Statuses & Resolution

Status is an element that represents the specific state or condition of a payout at any point in its lifecycle. It is primarily used to track the progress of the Payout and monitor the various stages it moves through.

Resolution represents the immediate confirmation of a state and displays the final outcome of an individual payout stage.

Payout Request

A Payout Request is a merchant-created entity that acts as the primary instruction to initiate a fund transfer to a Recipient.

Payout Request Statuses

Status	Description
created	Payout Request is successfully created. Initial status.
expired	Payout Request has expired and is no longer valid.
attempted	Payout attempt was initiated for the Payout Request. The Payout has not been completed.
pending	Payout Request has been created and accepted for processing, but the funds have not been sent yet.
payouted	The Payout Request was processed, and a Payout was finalised successfully.
failed	The Payout Request has failed to be finalised.

Payout Request Resolutions

Resolution	Description
ok	The process completed successfully.
expired	The Payout Request has expired.
attempt_limit_reached	The defined Attempt limit has been reached.
merchant_account_disabled	The given Merchant account has been disabled.
organization_disabled	The given Organisation has been disabled.
blocked_by_firewall_rules	The Request has been blocked due to established Firewall rules.
blocked_due_to_firewall_failure	The Request has been blocked because of the Firewall failure.

Payout Commit

The Payout Commit is a processing stage that validates and triggers the execution of a Payout Request.

Payout Commit Statuses

Status	Description
created	Payout Commit has been created.
pending	Payout Commit has been created and is being processed. The Payout is awaiting execution or confirmation, and the final outcome has not been determined yet.
processed	Payout Commit has been successfully processed.
failed	Payout Commit has failed and was not processed.
expired	Payout Commit has expired and is no longer valid.

Payout Commit Resolutions

Resolution	Description
ok	The process was completed successfully.
process_failed	The Payout processing was started but failed during execution.
processing_error	The system errors occurred.
no_route_available	No Payout route could be selected for processing the Payout.
insufficient_balance	The Merchant’s balance is not sufficient to execute the Payout.
cancelled_by_user	The Payout Commit was cancelled by the user before completion.
transactions_limit_reached	The Payout could not be processed because the Transaction limit was exceeded.
no_available_routes_for _selected_method	No Payout routes are available for the chosen Payout method.
blocked_by_firewall_rules	The Payout was blocked by configured Firewall rules.
filter_received_no_routes	All Payout routes were filtered out during Routing evaluation.
strategy_specified_ routes_pre_filtered	Routes specified by the Routing strategy were filtered out before processing.
no_routes_by_enabled _provider_account	No enabled Provider accounts are available for Payout processing.
no_routes_by_ strategy_options	Routing strategy options excluded all available Payout routes.
strategy_returns_no_routes	The Routing strategy did not return any eligible Payout routes.
no_routes_by_fields	No Routes matched the required Payout field criteria.
no_routes_by_currencies	No Payout routes support the specified currency.
no_routes_by _failure_history	All Routes were excluded due to previous failure history.
no_routes_by _firewall_rules	Firewall rules excluded all available Payout routes.
no_routes_due_to _firewall_failure	No Routes are available because of Firewall rule evaluation failures.
no_routes_by _processing_options	Processing options filtered out all available Payout routes.
no_routes_by _turnover_limits	Turnover limits prevented any Route from being selected.
no_routes_by_merchant _account_amount_limits	The Payout amount exceeds Merchant account limits.
no_routes_by_payment _route_amount_limits	The amount exceeds configured Route limits.
no_routes_by_enabled_provider _account_payment_gateway	No enabled Provider accounts are available for the payment gateway.
no_routes_by_enabled_provider _account_payout_gateway	No enabled Provider accounts are available for the payout gateway.
no_routes_by_conditions	Route condition rules excluded all Payout routes.
terminated_by _trigger_rules	The Payout Commit was terminated by trigger-based rules.
strategy_received_no_routes	The Routing strategy received no Routes for evaluation.
terminated_by _routing_rules	Routing rules explicitly terminated the Payout Commit.
hard_declined	The Payout was declined by the Provider and cannot be retried.
expired	The Payout Commit expired before it could be successfully processed.