LimitlexPAY allows merchants to interact with payment gateway platform programmatically via HTTP API. Service URL:
API calls are generated with a URL, followed by the endpoint URL and request data.
API calls are authenticated using HTTP Basic access authentication. You can generate your API key in your API Settings.
The API returns results in JSON format.
On error there will be an err element in the result. Err value will contain the error description.
API calls are performed by sending a HTTP request to the URL starting with a link, followed by the endpoint URL and request data.
| Method | Request | Response |
|---|---|---|
| GET | /GetBalance/ |
returns [{address, currency, balance}] |
| GET | /GetPayout/?id={id} |
returns {id, inserted, fee_type, date_scheduled, date_cancelled, status, transactions[]}
|
| GET | /GetPayouts/?limit={limit}&offset={offset} |
returns [{id, inserted, fee_type, date_scheduled, date_cancelled, status}] |
| GET | /StartPayout/?currency={currency}&address={address}&amount={amount}&fee_type={fee_type} |
returns {id} |
| POST |
/StartMassPayout/Requires a json element with fee_type and transactions in the body with a list of all out addresses. Each address needs to be in following format:
|
returns {id} |
| GET | /ConfirmPayout/?id={id} |
returns {confirmed, date_scheduled, wait_time} |
| GET | /CancelPayout/?id={id} |
returns {cancelled} |
Replace {text} with request data: (e.g {currency} -> BTC)
| Parameter | Meaning |
|---|---|
| id | ID of the payout return from /StartPayout or /StartMassPayout endpoint. |
| fee_type | Fee type: fixed_in (send amount specified / receive amount specified minus fee) or fixed_out (send amount specified plus fee / receive amount specified). |
| currency | Cryptocurrency symbol (BTC, ETH..) |
| address | The target address that should receive the amount |
| amount | Amount of the currency that should be sent |
| limit | Limit how many payouts to return (optional, default 20, max 200) |
| offset | How many payouts to skip (optional, default 0) |
| Output | Meaning |
| amount | Total amount to send |
| currency | Cryptocurrency symbol (BTC, ETH..) |
| balance | Current balance on wallet |
| address | The target address that should receive the amount |
| id | Payout ID. |
| inserted | Date and time of the payout creation |
| fee_type | Fee type: fixed_in (send amount specified / receive amount specified minus fee) or fixed_out (send amount specified plus fee / receive amount specified). |
| date_scheduled | Date and time when the payout was scheduled |
| date_cancelled | Date and time when the payout was cancelled |
| status | Payout status description (pending confirmation, scheduled, cancelled) |
| wait_time | Expected time to confirm |
| confirmed | Is confirmation successfull (true/false) |
| cancelled | Is cancellation successful (true/false) |
The GetBalance API call is used to get details about all wallets related to a user.
Example:
https://pay.limitlex.com/api/v2/GetBalance/
Response:
[{
"address": "b90a2cf053724671898018ffg72fa68e65",
"currency": "BTC",
"balance": "0.21164052"
},{
"address": "33P6AnQfheFxnajXQwFas5jyo1nuhTY4M8",
"currency": "ETH",
"balance": "0.78000052"
}]
The GetPayout API call is used to get details about payout. Requires id parameter received from /StartPayout/ or /StartMassPayout/ API call.
Example:
https://pay.limitlex.com/api/v2/GetPayout/?id=a6425185-7ad9-4bb5-b82c-6ca2456b02cc
Response:
{
"id": "a6425185-7ad9-4bb5-b82c-6ca2456b02cc",
"inserted": "2021-09-22 09:59:30",
"fee_type": "fixed_in",
"date_scheduled": null,
"date_cancelled": null,
"status": "pending confirmation",
"transactions": [
{
"currency": "ETH",
"address": "33P6AnQfheFxnajXQwFas5jyo1nuhTY4M8",
"amount": "1.00000000",
}
]
}
The GetPayouts API call is used to get details about already created payouts.
Example:
https://pay.limitlex.com/api/v2/GetPayouts/?offset=0&limit=20
Response:
[
{
"id": "a6425185-7ad9-4bb5-b82c-6ca2456b02cc",
"inserted": "2021-09-22 10:36:06",
"fee_type": "fixed_in",
"date_scheduled": null,
"date_cancelled": null,
"status": "pending confirmation",
}
]
Start new payout to address.
Example:
https://pay.limitlex.com/api/v2/StartPayout/?currency=BTC&amount=0.02&fee_type=fixed_in&address=33P6AnQfheFxnajXQwFas5jyo1nuhTY4M8
Response:
{
"id": "a6425185-7ad9-4bb5-b82c-6ca2456b02cc"
}
Start new payout to multiple addresses.
Example:
https://pay.limitlex.com/api/v2/StartMassPayout/
Body:
{
"fee_type" => "fixed_in",
"transactions": [
{
"currency" : "ETH,
"address" : "33P6AnQfheFxnajXQwFas5jyo1nuhTY4M8",
"amount" : 0.014
}
]
}
Response:
{
"id": "a6425185-7ad9-4bb5-b82c-6ca2456b02cc"
}
The ConfirmPayout API call is used to confirm payout with ID received from from /StartPayout/ or /StartMassPayout/ API call. Returns wait time.
Example:
https://pay.limitlex.com/api/v2/ConfirmPayout/?id=a6425185-7ad9-4bb5-b82c-6ca2456b02cc
Response:
{
"confirmed": true,
"date_scheduled": "2021-09-22 9:46:12",
"wait_time": "120 minutes"
}
The CancelPayout API call is used to cancel payout with ID received from from /StartPayout/ or /StartMassPayout/ API call. Confirmed payouts can't be cancelled.
Example:
https://pay.limitlex.com/api/v2/CancelPayout/?id=a6425185-7ad9-4bb5-b82c-6ca2456b02cc
Response:
{
"cancelled": true,
}