Payout

get
β€Ž
https://<domain>/<api prefix>/<version>/user/get/payment-methods/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/get/payment-methods/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>'
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/payment-methods/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS => array(),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>'
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

post
β€Ž
https://<domain>/<api prefix>/<version>/user/change/payment-method/

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/user/change/payment-method/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>'
},
formData: {
'<method_key>-status': '<0 or 1>',
'<method_key>-status': '<0 or 1>',
...
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/change/payment-method/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('<method_key>-status' => '<0 or 1>','<method_key>-status' => '<0 or 1>',..),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>'
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​

Status Code
Error Type
Field
Description
400
Validation Error
<method_key>-status
<method_key>-status field not found. <method_key>-status value not found.
<method_key>-status recieved a invalid value.

get
β€Ž
https://<domain>/<api prefix>/<version>/user/get/payment-method/settings/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/get/payment-method/settings/?method=<method_key>',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/payment-method/settings/?method=<method_key>',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
method
This field is required.
This field is may not be blank.
Requested method is not found.
Requested method is not activated.

get
β€Ž
https://<domain>/<api prefix>/<version>/get/checksum-token/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/get/checksum-token/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
'Cookie': 'store_user=admin_store; sessionid=5zuhah7hbh4newylvnluxvpgt1clo0i1'
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/get/checksum-token/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_POSTFIELDS => array(),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

post
β€Ž
https://<domain>/<api prefix>/<version>/user/update/payment-method/settings/

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/user/update/payment-method/settings/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>'
},
formData: {
'method': '<method_key>',
'token_field': '<token>',
'token_checksum_field': '<token_checksum>',
'<required_field_1>': '<field_value>',
'<required_field_2>': '<field_value>',
...
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/update/payment-method/settings/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('method' => '<method_key>','token_field' => '<token>','token_checksum_field' => '<token_checksum>','<other_required_fields>' => '<field_values>',..),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
method
This field is required.
This field is may not be blank.
Requested method is not found.
Requested method is not activated.
400
Validation Error
token_field
This field is required.
This field is may not be blank.
400
Validation Error
token_checksum_field
This field is required.
This field is may not be blank.
400
Validation Error
other required fields for the
payment method.
other fields validation errors.

get
β€Ž
https://<domain>/<api prefix>/<version>/user/get/payout/history/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/get/payout/history/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/payout/history/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
currency_code
Invalid Currency Code.
400
Validation Error
from_date
Invalid date format
400
Validation Error
to_date
Invalid date format
400
Validation Error
status
Invalid status value.

get
β€Ž
https://<domain>/<api prefix>/<version>/user/withdraw/request/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/withdraw/request/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>'
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/withdraw/request/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

get
β€Ž
https://<domain>/<api prefix>/<version>/user/withdraw/request/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/withdraw/request/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/withdraw/request/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>'
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
wallet
This field may not be blank.
400
Validation Error
wallet
Wallet withdrawal is disabled, Please contact your admin.
400
Validation Error
currency_code
Invalid Currency Code.

post
β€Ž
https://<domain>/<api prefix>/<version>/user/withdraw/request/

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/user/withdraw/request/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <acess token>'
},
formData: {
'method': '<payment_method>',
'wallet': '<wallet_key>',
'amount': '<amount>',
'token_field': '<mail_token>',
'token_checksum_field': '<token_checksum>'
'form_key':'<form_post_key>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/withdraw/request/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('method' => '<payment_method>','wallet' => '<wallet_key>','amount' => '<amount>','token_field' => '<mail_token>','token_checksum_field' => '<token_checksum>','form_key':'<form_post_key>'),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
currency_code
Invalid Currency Code.
400
Validation Error
wallet
wallet is not defined.
Wallet withdrawal is disabled, Please contact your admin.
Already a request is pending.
Insufficient wallet balance.
400
Validation Error
amount
amount is not defined.
Please enter valid amount.
Minimum withdrawal amount is <min_amount>
Maximum withdrawal amount is <min_amount>
400
Validation Error
method
method is not defined.
Please choose a valid payout methods.
Some encryption error occured.
No account details found for this wallet.
No payment method details found for this wallet.
insufficient wallet balance.
You can't create the request, your <payout_limit_period> balance is <max_formated_amount>
Unable to continue this request, Please contact your administrator
400
Validation Error
token_field
This field is required.
This field is may not be blank.
Token is not matching.
400
Validation Error
token_checksum_field
This field is required.
This field is may not be blank.
401
Request Failed
​
Payout Request History Failed.
Payout Request Failed.
400
Validation Error
form_key
This field is required.
This field is may not be blank.
You have another form running, Please reload.

delete
β€Ž
https://<domain>/<api prefix>/<version>/user/cancel/withdraw/request/

Node
var request = require('request');
var options = {
'method': 'DELETE',
'url': 'https://<domain>/<api prefix>/<version>/user/cancel/withdraw/request/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access tooken>',
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/cancel/withdraw/request/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
οΏΌοΏΌValidation Error
wallet
This field is required.
This field may not be blank.
Invalid wallet.
400
οΏΌοΏΌValidation Error
payout_id
This field is required.
This field may not be blank.
Invalid payout id.
400
οΏΌοΏΌValidation Error
payout_id
Withdrawal request is invalid.
Withdrawal request is invalid.No transaction found.
​
​
Last modified 10mo ago
Copy link
On this page
Get Payment Methods
get
Change Payment Method
post
Get Payment Method Settings
get
Get Checksum Token
get
Update Payment Method Settings
post
Payout History
get
Request Payout
Get Payout Enabled Wallets
get
Get Payment Methods
get
Request Payout
post
Cancel Payout Request
delete