Initiate New Payout Request

Developing

POST

https://api-demo.hybridmlm.io/rest/api

This endpoint allows you to initiate a payout request to transfer funds from the platform to a user's designated external account or wallet. Payout requests facilitate to withdraw the amount in the users wallet.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params multipart/form-data

Responses

🟢200Success

application/json

Body

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-demo.hybridmlm.io/rest/api' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--form 'purpose="newPayoutRequest"' \
--form 'params[amount]="20"' \
--form 'params[pin]="123456"' \
--form 'params[remark]="Remarks"' \
--form 'params[gateway]="60"' \
--form 'params[account_id]="1"' \
--form 'params[wallet]="50"'

Response Example

200 - Success

{
    "status": true,
    "data": {},
    "message": {
        "success": [
            "payout requested successfully"
        ]
    }
}

Modified at 2025-03-28 05:46:25

Retrieves Payout Wallets List

Retrieve Payout Gateways