Initiate New Payout Request

Developing

POSThttps://training-v8.hybridmlmsoftware.com/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: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxNCIsImp0aSI6IjBiZTg1ZDk3OTQyODhhMDE1YjE1NmM4MzU0NWJhMzBmODlmNDJhYWYyODVmNmJhYTljNTQ1ZGQxMTY3ZDBkZTU1MzdjYjhiYjRjNmQwODEzIiwiaWF0IjoxNzE2MzU5MDIxLjk1MTMzNTkwNjk4MjQyMTg3NSwibmJmIjoxNzE2MzU5MDIxLjk1MTMzODA1Mjc0OTYzMzc4OTA2MjUsImV4cCI6MTc0Nzg5NTAyMS45NDUyODg4OTY1NjA2Njg5NDUzMTI1LCJzdWIiOiIzIiwic2NvcGVzIjpbIioiXX0.BZgZ-FSc46BkkKMRiKTRoR_Q34zjngW5ubfpLPqrGUqWW-tiObWP8ZGa5JK62FtqWtZ8gVRufknW2tRnfuo5yf4XRyrf8I7p6EG9fdeT0JporThnuMgGszPZZeDKKjbgOtj0hJX8AM39Ezfu-o-tY7XG4uG8LhYxsh1PlLOxDVawwoS_7tIvCfhBAbh59OeK3c_rikHuuunO_DIqCYl3LFs0si-ooZOh15xGjERCeoWxhDmLrlZkRaMywdR9gCWCho38bGuRJdm954xHzkK68ZBMB6w-xoHvsmCcQ8keQtRP4XyJNmKaBTuErOsP_GB0wL9jiCm4NKPLeJLC-O4disbcnGXR1A37Jmknp2seeUOFvllxUp27W_9xBq3GR_QprrHPdyBmsbmah1TdSnvc1fbTpDu5mvk_GewhRATLLBDisCyJ7rlMO9uTOqMzXC1VuXPLuC-kOEeAzRi_C8tgCHde0t1D--uZr_vFuD4CpfbSHGKJ7AmKjKmlW4fb7j_7jKCFTG5MpPSb6syylKAKnCtAXiJGyuKITtMSzET8krBws3uSIzd4m6UoLO6VOXizOlr6CyIXtXCuJ33jxGA6O_z34BKxvZ_Asu5MN7nPH_7diC-W8d9Ckv6Z377ibx5k0IZgutlJFnBhh31Sw40T474-tBik9k_-MxRATrFiOqk

Body Params multipart/form-data

purpose

string

required

Example:

newPayoutRequest

params[amount]

integer

required

Example:

params[pin]

integer

required

Example:

123456

params[remark]

string

optional

Example:

Remarks

params[gateway]

integer

required

you will get gateway details from Retrieve Payout
Gateways Api from that you choose id of the gateway you want.

Example:

params[account_id]

integer

required

you will get account details from Retrieve User Payout Accountslist Api from that you choose the account_id you want.

Example:

params[wallet]

integer

required

you will get wallet details from Retrieves Payout Wallets List Api from that you choose id of the wallet you want.

Example:

Request samples

Responses

Success(200)

Parameter Error(422)

HTTP Code: 200

Content Type : JSONapplication/json

object {0}

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

Last modified: 8 months ago