API Call Sequence

Overview

The Payouts feature facilitates the initiation and management of payout requests for specified shops. It allows for the definition of payout amounts and purposes.

API Call Sequence

1. Retrieve Payout Methods: Obtain the available payout methods for your shop.
2. Get Required Payout Fields: Based on the providerCode and InstrumentType, obtain the necessary fields required for executing a payout. The available options for these parameters can be acquired by contacting technical support. The available providerCode and InstrumentType for your shop can be obtained from technical support.
3. Create Payout Request: A payout request is created by specifying the necessary details obtained from the previous step.
4. Check Payout Status: After initiating a payout, its status can be tracked through the retrieval endpoint, providing transparency and updates on the payout process.

Payout Life Cycle

Status	Description
registered	This is a technical status indicating that the payout has been registered in the system. Immediately after registration, the payout transitions to in_progress.
in_progress	The payout has been created and is in progress. It can transition to Rejected if not completed within the allotted time and be cancelled due to timeout, to Failed if there is a problem on the provider's side, or to Completed if the payout is successfully processed.
сompleted	The payout has been successfully completed.
failed	The payout did not go through on the provider's side. Provider error.
rejected	The payout was cancelled due to a timeout.
cancelled	In development. Currently not in use.
need_action	Payout requires merchant action to complete the transaction.