API Reference

Response & Errors

Features:

  • Response is in JSON document.
  • WARMKEY doesn't rely on HTTP code if exception occured.

Mandatory Parameters

ParameterType / FormatDescription
codestring / uint64Error if code != 100.
messagestringError message if code != 100.
resultgenericEach API endpoint has its own result design.
noncestring / milliseconds13 digits
signaturestring / hex64-bytes signature generated with hash256( json_encode['code'=>..., 'message'=>..., 'result'=> ..., 'nonce'=>...] )

For example,

{
	"code": "100",
	"message": "Success",
	"result": ["... some value ..."]
}

Success

CodeMessageDescription
100SuccessSuccess

General Errors

Code range from 101 to 199.

CodeMessage
101Invalid signature
102WARMKEY is under maintenance
103API key not valid
104Nonce not valid
105Rate limit exceeded
106API method not valid
107This API method is under maintenance

DAPP Errors

Payment Gateway

Code range from 200 to 299

CodeMessage
200Withdrawal denied. $reason
201Withdrawal denied. Unique ID was existed.
202No payment was made.