API Document

Our payment API methods and examples

Our methods in HTTP GET protocol (recommended)

Send to address

To send coins to an address use this method.
Request URLs
HTTPS: https://api.epay.info/v1/send Highly Recommended
HTTP: http://api.epay.info/v1/send
Parameters
Parameter Description
api The code that you got from MyFaucet panel when you added your faucet.REQUIRED
to The address that you want to send the coin.REQUIRED
amount The amount that you want to send, Must be in satoshi.REQUIRED
Note In case of Dogecoin please don't send satoshi. e.g. 1 Doge , 2 Doge , 10 Doge
type Input 1 for normal payments, 2 for referral payments.
2 will override time and budget limit on faucet Default 1 optional
note A small note to be shown in the transactions list.Default NULLoptional
user_ip The actual user IP to help fighting bots, TOR and bad users. Default NULLoptional

PHP example code

https://api.epay.info/v1/send?api=YOUR_API_KEY_HERE&to=CURRENCY_ADDRESS_HERE&amount=100
Return parameters
Will return values in JSON You must check the status key. Here is list of status possible values
Parameter Description
>0 Successful transaction. and transaction id
Will have additional key time that is the next time that address is able to receive again. UNIX Time
-2 API code not found.
-3 Insufficient balance
-4 REQUIRED parameter missing
-5 Payment is sooner than the calculated time out for address.
Will have additional key time that is the next time that user is able to receive again. UNIX Time
-6 ACL is active and server IP address is not authorized.
-7 User IP address is blocked./Bad IP
-8 User country is blocked.
-9 Budget reached and transaction has been canceled
-10 Daily budget reached
-11 time-frame limit reached
-13 Per user's daily budget reached
-100 Your server ip address is blocked on ePay.info.
Add ACL on your faucet setting to overide.

Check Balance

To check your balance use this method, This function will not respect ACL
Request URLs
HTTPS: https://api.epay.info/v1/balance Highly Recommended
HTTP: https://api.epay.info/v1/balance
Parameters
Parameter Description
api The code that you got from MyFaucet panel when you added your faucet.REQUIRED

PHP example code

https://api.epay.info/v1/balance?api=YOUR_API_KEY_HERE
Return parameters
Will return values in plain text.
Parameter Description
>0 Your currency balance in satoshi
-2 API code not found.
-4 REQUIRED parameter missing

Budget Check

To check your balance use this method, This function will not respect ACL
Request URLs
HTTPS: https://api.epay.info/v1/budget Highly Recommended
HTTP: https://api.epay.info/v1/budget
Parameters
Parameter Description
api The code that you got from MyFaucet panel when you added your faucet.REQUIRED
to Users address if you want to check user's daily budgetoptional

PHP example code

https://api.epay.info/v1/budget?api=YOUR_API_KEY_HERE
Return parameters
Will return values in JSON
Parameter Description
server_time Curren server time
window_begin Limit checking window begin time
window_end Limit checking window end time
rotator_budget Remaining amout before trigerring rotator budget
api_limit Remaining amout before trigerring 30 minutes API limit budget
daily_limit Remaining amout before trigerring daily API limit budget
user_budget Remaining amout before trigerring user's daily budget

Our methods in SOAP protocol

Send to address

To send coins to addresses use this method.
Web service URL
HTTPS: https://api.epay.info/?wsdl Highly Recommended
HTTP: http://api.epay.info/?wsdl
Function to call
You have to call send
Input parameters
Parameter Description
API Code The code that you got from MyFaucet panel when you added your faucet.REQUIRED
Address The address that you want to send the coin.REQUIRED
Amount The amount that you want to send, Must be in satoshi.REQUIRED
Note In case of Dogecoin please don't send satoshi. e.g. 1 Doge , 2 Doge , 10 Doge
Transaction Type Input 1 for normal payments, 2 for referral payments.
2 will override time and budget limit on faucet optional
Note A small note to be shown in the transactions list.Default NULLoptional
User IP The actual user IP to help fighting bots, TOR and bad users. Default NULLoptional

PHP example code

$client = new SoapClient('https://api.epay.info/?wsdl');
$response = $client->send($apicode,$user_wallet,$amount_to_send,1,$note,$ip);
Return parameters
Will return values in an array. You must check the status key. Here is list of status possible values
Parameter Description
>0 Successful transaction. and transaction id
Will have additional key time that is the next time that address is able to receive again. UNIX Time
-2 API code not found.
-3 Insufficient balance
-4 REQUIRED parameter missing
-5 Payment is sooner than the calculated time out for address.
Will have additional key time that is the next time that user is able to receive again. UNIX Time
-6 ACL is active and server IP address is not authorized.
-7 User IP address is blocked./Bad IP
-8 User country is blocked.
-10 Daily budget reached
-11 time-frame limit reached
-100 Your server ip address is blocked on ePay.info.
Add ACL on your faucet setting to overide.

Check Balance

To check your balance use this method, This function will not respect ACL
Web service URL
HTTPS: https://api.epay.info/?wsdl Highly Recommended
HTTP: http://api.epay.info/?wsdl
Function to call
You have to call f_balance
Input parameters
Parameter Description
API Code The code that you got from MyFaucet panel when you added your faucet.REQUIRED
flag no option, enter 1REQUIRED

PHP example code

$client = new SoapClient('https://api.epay.info/?wsdl');
$response = $client->f_balance($apicode,1);
Return parameters
Will return values in plain text.
Parameter Description
>0 Your currency balance in satoshi
-2 API code not found.
-4 REQUIRED parameter missing
List of array keys to check
Key Description
rotator_budget Amount you have reached in the last 30 minutes for rotator budget
api_limit Amount you have reached in the last 30 minutes for api limit
daily_limit Todays remaining budget