API documentation

https://xrpapi.net/api/.<METHOD>?key=<YOUR_API_KEY>&param1=value1&param2=value2&...

Parameter Description Example
METHOD One of the methods:
balance - Get balance
give - Create new invoice
send - Create request of sending coins
status - Get status of request
balance
YOUR_API_KEY Your API access key from settings 5c2dc9d3fa-df73e0d10d-2715eb503f-685b1965d8
address Destination address r-address: r4J7bd5XHeyfRE75z7XUG8RjLyNq7YvSTH
or r-address with destination tag: r4J7bd5XHeyfRE75z7XUG8RjLyNq7YvSTH:123456
or X-address: XVexCx7AYysWH8wbYDu7eD1zmbatbnovTGCZf5bNypj26XC
tag* Destination tag Any integer number between 1 and 999999: 123456
amount Amount of XRP coins 0.123456
statusURL* (URL-encoded) URL to your IPN handler https://your-domain/handler.php?a=1&b=2
label* Label of operation Any string: oper12
fee* Fee amount in drops 10

Examples

https://xrpapi.net/api/.balance?key=<YOUR_API_KEY>

https://xrpapi.net/api/.give?key=<YOUR_API_KEY>&label=oper12&statusURL=<URL_ENCODED>

https://xrpapi.net/api/.send?key=<YOUR_API_KEY>&address=<PAYEE_ADDR>&tag=<PAYEE_TAG>&amount=<AMOUNT>&label=oper12&statusURL=<URL_ENCODED>

https://xrpapi.net/api/.status?key=<YOUR_API_KEY>&id=<REQUEST_ID>

IPN handler

Data in JSON format:
{
   xrpapi.net: version
   type: message type = (in-payment / out-sending)
   date: date and time in UNIX format
   from: address-sender
   to: address-receiver
   tag: destination tag
   xaddress: x-address-receiver
   amount: amount
   fee: fee
   txid: transaction txid (hash)
   label: label
   sign: signature
}

PHP Code Example:
...
if (!$_POST)
   $_POST = @json_decode(file_get_contents('php://input'), true);
if (!$_POST['xrpapi.net'])
   return;
$sign = sha1(implode(':', array(
   $_POST['type'],
   $_POST['date'],
   $_POST['from'],
   $_POST['to'],
   $_POST['tag'],
   $_POST['amount'],
   $_POST['fee'],
   $_POST['txid'],
   $_POST['label'],
   $cfg['apikey'] // API access key
)));
if ($sign !== $_POST['sign'])
   die('Sign wrong'); // this answer will be visible in the dashboard
echo('OK');
...

Pricing

We don't take a percentage from a transaction and do not require a monthly fee. You pay only for actually spent resources (cost of 1 credit = 0.01 USD):

Calculation examples (if statusURL is specified):

Note that the amount of credits is independent of the transaction amount