Create Payout Request
POST/payouts
Initiates a new payout request for a specified shop, defining the payout amount, purpose, and optional payout and recipient settings. To fill out the body data of this endpoint, use the endpoints: [Retrieve Payout Methods]/docs/merchant-api/get-app-external-v-1-payout-shop-getshoppayoutmethods) and [Retrieve Required Payout Fields]/docs/merchant-api/get-app-external-v-1-payout-payoutfields-getfields).
For all payouts, a Time-To-Live (TTL) of 1 week is set, starting from the moment the payout is created. If the payout process has not been successfully completed within 7 days after the TTL expires, the system will automatically change the payout's status to failed.
This automatic status change to failed indicates that the payout attempt was not completed within the required time frame. However, this status change does not stop the system from continuing to process updates or responses from the payment provider. For example, if after the status is marked as failed, the payment provider later confirms a successful or unsuccessful transaction, the payout status could still be updated based on this new information. The failed status simply reflects that the payout wasn't completed within the allowed timeframe, but it does not prevent further updates or changes to the status in the future.
Request​
Responses​
- 201