Top-Up API 请求示例与响应

示例

格式：JSON-RPC

// 
{
  "id": "6164699909785264260",
  "jsonrpc": "2.0",
  "method": "topup",
  "params": [
    {
      "isForTest": 1,
      "price": {
        "amount": "50000",
        "currency": "IDR"
      },
      "serviceProvider": "Coda",
      "quantity": 1,
      "paymentChannelId": 227,
      "sku": "Diamonds_10",
      "purchaseOrigin": "TH",
      "user": {
        "userId": "111111",
        "zoneId": "101",
        "roleId": "111"
      },
      "signature": "73d173363f6706d59c35bcea785f543488389b68d582a9b2339e9450db177695",
      "txnId": "6164699909785264260",
      "orderId": "6164699909782101750",
      "merchantTransactionId": "816176257914769"
    }
  ]
}

参数名称	类型	描述
id	字符串	唯一标识此次 API 调用的 ID。
jsonrpc	字符串	固定为 "2.0"，符合 json-rpc 标准。
method	字符串	固定为 "validate"。
params.serviceProvider	字符串	支付服务提供商名称，默认值为 "Coda"，合作伙伴可自定义。
params.isForTest	整数	是否为测试订单的标志：1 表示沙盒测试订单，0 表示真实订单。
params.signature	字符串	根据消息内容生成的签名，详见签名生成部分。
params.user.userId	字符串	用户在合作伙伴系统中的用户 ID 或玩家 ID。
params.user.zoneId	字符串	用户在合作伙伴系统中的区服 ID，若不需要则为 ""（空字符串）。
params.price.currency	字符串	货币代码，采用 ISO 4217 标准，例如 "USD"、"CNY"。
params.price.amount	字符串	用户支付的金额，单位为所指定货币。
params.sku	字符串	商品 ID，例如 "Diamonds_123"，用于标识虚拟商品。
params.purchaseOrigin	字符串	用户购买时所在国家/地区，使用 ISO 两位国家代码（如 "SG"、"US"）。
params.quantity	整数	所购买的商品数量，通常为 1。
params.paymentChannelId	整数	支付渠道的 ID，详见文档第 6 节。
params.txnId	字符串	支付交易的唯一标识符。
params.orderId	字符串	Codashop 生成的订单 ID。

充值请求响应

Codashop 的充值请求响应用于描述发行商对一次充值请求的响应情况。

以下是有效和无效充值响应的示例说明。

---

有效的充值交易响应

格式：JSON-RPC

{
  "id": "6164699909785264260",
  "jsonrpc": "2.0",
  "result": 0

参数名称	描述
id	与该响应关联的消息 ID。
jsonrpc	固定为 "2.0"，符合 json-rpc 标准。
result	一个对象，表示操作成功。

无效充值交易响应说明

该响应表示充值失败的情况。

虽然验证过程中的失败是预期内的，但在此方法中返回失败通常属于异常事件，因为在调用充值接口前，所有参数应已通过验证。

示例

格式：JSON-RPC

{
  "id": "6164699909785264260",
  "jsonrpc": "2.0",
  "error": {
    "code": -103,
    "message": "Server is under maintenance"
  }
}

参数名称	描述
id	与该响应关联的消息 ID。
jsonrpc	固定为 "2.0"，符合 JSON-RPC 标准。
error.code	表示错误原因的代码。
error.message	描述错误情况的消息。