Features:
- Response is in JSON document.
- WARMKEY doesn't rely on HTTP code if exception occured.
Mandatory Parameters
| Parameter | Type / Format | Description |
|---|---|---|
| code | string / uint64 | Error if code != 100. |
| message | string | Error message if code != 100. |
| result | generic | Each API endpoint has its own result design. |
| nonce | string / milliseconds | 13 digits |
| signature | string / hex | 64-bytes signature generated with hash256( json_encode['code'=>..., 'message'=>..., 'result'=> ..., 'nonce'=>...] ) |
For example,
{
"code": "100",
"message": "Success",
"result": ["... some value ..."]
}
Success
| Code | Message | Description |
|---|---|---|
| 100 | Success | Success |
General Errors
Code range from 101 to 199.
| Code | Message |
|---|---|
| 101 | Invalid signature |
| 102 | WARMKEY is under maintenance |
| 103 | API key not valid |
| 104 | Nonce not valid |
| 105 | Rate limit exceeded |
| 106 | API method not valid |
| 107 | This API method is under maintenance |
DAPP Errors
Payment Gateway
Code range from 200 to 299
| Code | Message |
|---|---|
| 200 | Withdrawal denied. $reason |
| 201 | Withdrawal denied. Unique ID was existed. |
| 202 | No payment was made. |