HYBRID MLM SOFTWARE
  1. New payout Request
HYBRID MLM SOFTWARE
  • Introduction
  • Authorization
    • Login
      • login
    • Forget Password
      POST
  • Register
    • Fetch Country List
      POST
    • Fetch State List
      POST
    • Username Existence Checker
      POST
    • Email Existence Checker
      POST
    • Sponsor Verification
      POST
    • User Registration
      POST
  • Profile
    • Retrieves User Profile Information
      POST
    • Modify User Profile Information
      POST
  • Dashboard
    • Fetch Dashboard Data
      POST
  • Payout
    • Payout Pin
      • Check Payout Pin Status
      • Initiate User Payout Pin Creation
      • Update User Payout Pin
      • Manage Forgotten Payout Pin
    • Payout Accounts
      • Retrieve User Payout Accounts List
      • Retrieve Account Fields Data
      • Register Payout Account For User
      • Delete User Payout Account
    • New payout Request
      • Retrieves Payout Wallets List
        POST
      • Initiate New Payout Request
        POST
    • Retrieve Payout Gateways
      POST
    • Revoke User Payout Request
      POST
    • Check Payout Status
      POST
    • Retrieve Payout History Data
      POST
  • Wallet
    • Transaction Password
      • Check Transaction Password Status
      • Initiate User Transaction Password
      • Update Transaction Password For User
      • Manage Forgotten Transaction Password
    • Retrieve List Of Wallets
      POST
    • Fetch Wallet Balance
      POST
    • Initiate Funds Transfer
      POST
    • Retrieve Transaction Operations
      POST
    • Retrieve User Transactions
      POST
  • News
    • Fetch All News
    • Fetch Single News
  • Reports
    • Earning Report
      • Fetch Earning Report Filter Details
      • Show Filtered Earning Report
    • Refferal List
      • Fetch User Referral List
    • Downline List
      • Fetech User Downline List
  • Mail
    • Compose Mail
    • Reply Mail
    • Retrieve Inbox Mails
    • Retrieve Send Mails
    • Star Mail
    • UnStar Mail
    • Retrieve Starred Mail
    • Retrieve Trashed Mail
    • Delete Mail
  1. New payout Request

Initiate New Payout Request

Developing
POST
https://api-demo.hybridmlm.io/rest/api
payoutRequest
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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-demo.hybridmlm.io/rest/api' \
--header 'Accept: application/json' \
--header 'Authorization: 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' \
--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 Response Example
200 - Success
{
  "status": true,
  "data": {},
  "message": {
    "success": [
      "payout requested successfully"
    ]
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Accept
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:
20
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:
60
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:
1
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:
50

Responses

🟢200Success
application/json
Body
object {0}
🟠422Parameter Error
Previous
Retrieves Payout Wallets List
Next
Retrieve Payout Gateways
Built with