API Reference

创建充值请求

(GET) https://api.warmkey.finance/paymentV1/interface

充值链接的生成方式与其他 API 不同。根据您的使用情况，它可以由服务器端或客户端调用。

充值链接的查询参数

在客户端实现方面，您可以将用户从商家网站重定向到 WARMKEY 以进行应用外集成，或者您可以将此链接放在 IFRAME 中以进行应用内集成。

在服务器端实现中，只需使用 CURL 查询即可接收 JSON 响应。

参数类型/格式必填描述
accountstring✅md5(api key)
pathstring ✅- bip44 的相对路径。
- 格式为表 ID/记录 ID，例如 1/123。
- 用户定义的表 ID：1 可以代表订单、用户或任何表。
- 用户定义的记录 ID：123 可以是订单 ID、用户 ID 或任何主键ID。
html_configstring / base64- 以下是用于覆盖已保存/默认配置的 base64 解码字符串。

{
"features": {
"footer": true,
"fullscreen": true,
"connectWeb3Wallet": true
},
"themeVariables": {
"--w3m-font-family": "'Noto_Sans_a57643', 'Noto_Sans_Fallback_a57643'",
"--w3m-border-radius-master": "4px",
"--w3m-accent": "#10B981",
"--w3m-color-mix": "#363636",
"--w3m-color-mix-strength": 10
},
"themeMode": "dark"
}

- 此设置仅对响应中的 HTML 内容产生影响。
responsestring枚举类型：["json", "html"]，默认值为 html。
langstring枚举类型：["zh_CN", "en_US"]，默认值为 en_US。
signaturestring✅64字节签名。

签名生成

使用 RSA private key 方法生成签名。

$payload = [
    "account"=>md5($your_api_key), 
    "path"=>"1/123", 
];
$signature_data = json_encode($payload);
$to_sign = hash('sha256', $signature_data, true);
$your_private_key_pem = <<EOD
-----BEGIN PRIVATE KEY-----
MIIBVwIBADANBgkqhkiG9w0BAQEFAASCAUEwggE9AgEAAkEA1eerGN7aInrV0myN
5RYAVL58JsUQCdkIUYDLoupVLnhO8uw0DD5ooNwd8gT8KJU0UzKSpRN+sjSwutD3
ZMrvAQIDAQABAkEA1VLwmKIPa5mTSwLF1DTH6bv6tvOK1jdjC11mOLh4cRjoEw83
FzwSfuWlGyFGdir5PE5SK/1D8nZ41h8bnw9pAQIhAP/AQKUYlha+t7gGstFc+J6Z
9ZgoxT44ngyF5dE/4+FRAiEA1hz8Rpwwrm8pwp+kdho8guTwozmpvMrQYdRufjag
RrECIQCTtZrgf3m3+0CqlZvTlam2GF+jGPEKhbKqsu7P0uGvcQIhAIr1MtEMqxd6
M6sI+q5fZqg4tufoE33gTo8/VBp7j1dxAiEAsvhkqXu0AWvkJxVrCfQWiv5RMxAL
LXPLNzdej9IFEns=
-----END PRIVATE KEY-----
EOD;
$private_key = openssl_pkey_get_private($your_private_key_pem);
openssl_sign($to_sign, $your_signature, $private_key, OPENSSL_ALGO_SHA256);
$your_signature = bin2hex($your_signature);

充值链接生成

$deposit_link = "https://api.warmkey.finance/paymentV1/interface/?";
$payload = [
    "account"=>md5($your_api_key), 
    "path"=>"1/123", 
    "signature"=> $your_signature,
];
$deposit_link .= http_build_query($payload);

返回 URL 的查询参数

  • 当最终用户在 WARMKEY 取消或完成付款时，将用户从 WARMKEY 重定向到商家网站。
  • 仅当您实施 out-app（链接到 WARMKEY）解决方案时才可用。
  • 商家开发者可以根据这些返回的参数设计自己的返回界面与体验。
  • 请勿依赖这些返回参数进行关键操作。如想获取已确认交易，请调用Query Log接口。
参数类型/格式必填描述
txsstring / base64✅base64_encode(json_encode([]TX array))。如未检测任何充值则返回空数组。

TX阵列

数组索引类型/格式必需的描述
0string / address✅发件人地址。
1string / address✅充值地址。
2string / hex string✅交易哈希。
3string / double✅充值金额。
4string✅货币符号。
5string✅网络。

JSON 响应

这部分内容仅影响在查询参数中设置了 response=json 的用户。

参数类型/格式必填描述
$network网络对象✅键是网络，值是网络对象。

网络对象

参数类型/格式必填描述
qr_codestring / base64✅Base64图像。图像为二维码。
deposit_addressstring / address✅充值地址。