Payout Statuses & Resolutions

Status is an element that describes the state or condition of a payout throughout its lifecycle. Its main function is to enable progress tracking of the Payout and be aware of the stages it encounters.

Resolution refers to the instant confirmation of the state and the outcome of each payout stage.

Payout Request

The Payout Request is an entity that serves as the initial instruction to send funds to a Recipient, created by the Merchant.

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 Organization 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 step that confirms and executes the 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

Payout Transaction

The Payout Transaction is an individual transfer event representing the movement of funds within the Payout from a Merchant to a Recipient.

Payout Transaction Statuses

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_payment
_request_flow
The Request flow configuration excluded all Routes.
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.
Status Description
created A Payout Transaction has been created but has yet to be initiated or processed.
undefined The Transaction status has not been assigned yet.
unknown The Transaction state cannot be determined at the moment.
initiating The Payout initiation process for a specific Transaction has not yet been completed and is ongoing.
initiate_failed The attempt to initiate a Payout for a specific Transaction was unsuccessful.
initiated The payout process initiation was successfully completed for the specific Transaction.
processing The Transaction is currently processing.
process_pending The Payout Transaction has been created and sent for processing, but execution is still in progress, and the final status is not yet available.
processed The Transaction was successfully processed.
error An error occurred when processing a Payout.
failed The Transaction processing was unsuccessful.

Payout Transaction Resolutions


Resolution Description
ok The Transaction is processed.
general_error A system error occurred, preventing the Transaction from being completed. Please try again later.
unknown A system error occurred, preventing the Transaction from being completed. Please try again later.
undefined The resolution is undefined.
invalid_amount We were unable to process your Transaction due to the amount mismatch.
invalid_card One or several card credentials you entered are invalid.
invalid_token The token is invalid.
invalid_details One or several card credentials you entered are invalid.
credentials_expired There was an error processing your transaction.
account_blocked The Merchant account is blocked.
invalid_account The used account is invalid.
forbidden_ip The IP is forbidden.
invalid_signature The Callback X-signature is invalid.
functionality
_not_permitted
Restrictions are based on the use of functionality.
provider_fatal_error The Payment Provider returns a fatal error.
provider_timeout The waiting time from the Provider has been exceeded.
duplicated_transaction A system error occurred, preventing the Transaction from being completed. Please try again later.
transaction_not_found A Transaction could not be found.
expired The Payout Transaction has expired.
unable_to_reconcile The Reconciliation is unavailable.
session_expired The current session has expired.
connection_error A system error occurred, preventing the Transaction from being completed. Please try again later.
fatal_timeout The connection is terminated due to idle-in-transaction timeout.