Validation API 请求示例与响应

Codashop 交易验证请求

示例 JSON-RPC 格式 https://www.jsonrpc.org/specification

// {
  "id": "6164695159717629913",
  "jsonrpc": "2.0",
  "method": "validate",
  "params": [
    {
      "isForTest": 1,
      "price": {
        "amount": "50000",
        "currency": "IDR"
      },
      "serviceProvider": "Coda",
      "quantity": 1,
      "paymentChannelId": 227,
      "sku": "Diamonds_10",
      "purchaseOrigin": "TH",
      "user": {
        "userId": "111111",
        "zoneId": "101"
      },
      "signature": "4646fbd3363ab452f40187f8744cd321f71968ed01cdc19c416203832cddd76e",
      "txnId": "6164695159717629913",
      "orderId": "6164695159719894644"
    }
  ]
}

参数	类型	描述
id	String	标识 API 调用的唯一 ID
jsonrpc	String	固定值为 "2.0"，符合 JSON-RPC 标准
method	String	固定值为 "validate"
params.serviceProvider	String	支付服务提供商名称，默认值为 "Coda"，也可由合作伙伴自定义
params.isForTest	Integer	用于指示此订单是沙盒测试订单还是真实订单。如果 isForTest=1，此订单为沙盒测试订单；反之，isForTest=0，则为真实订单。
params.signature	String	根据请求内容生成的签名。详见“签名生成”部分。
params.user.userId	String	合作伙伴系统中客户账户的用户 ID / 玩家 ID
params.user.zoneId	String	合作伙伴系统中客户账户的区域 ID/服务器 ID。 如果不需要 zoneId，默认值为“”。
params.price.currency	String	货币代码，符合 ISO 4217 标准
params.price.amount	String	用户支付金额，货币单位由 params.price.currency 定义。
params.sku	String	表示所购买商品的商品 ID，例如 "Diamonds_123"。
params.purchaseOrigin	String	购买发起地区，采用 ISO 两位国家代码标准。Codashop 用户进行购买时所处的地区。 参考：https://www.iban.com/country-codes
params.quantity	Integer	待购买的 SKU 数量，通常为 1
params.paymentChannelId	Integer	支付渠道 ID，请查阅第 6 节
params.txnId	String	支付交易 ID
params.orderId	String	Codashop 订单 ID

Codashop 验证请求响应

Codashop 验证响应描述了合作伙伴对验证请求的响应。

下方提供了有效和无效验证响应的示例。

有效的验证响应

示例 1

格式：JSON-RPC

// 
{
  "id": "6164695159717629913",
  "jsonrpc": "2.0",
  "result": {
    "merchantTransactionId": "816176257914769",
    "username": "Test User",
    "accountRegionCode": "SG"
  }
}

示例 2

若每个账户下存在多个角色或子账户，且用户需选择充值对象，应将这些选项以 roleList 形式共享。仅包含可充值的角色。Coda 将在用户进行支付前展示这些选项。

// 
{
  "id": "6164695159717629913",
  "jsonrpc": "2.0",
  "result": {
    "roleList": [
      {
        "roleName": "roleA",
        "roleId": "111"
      },
      {
        "roleName": "roleB",
        "roleId": "222"
      },
      {
        "roleName": "roleC",
        "roleId": "333"
      }
    ],
    "merchantTransactionId": "816176257914769",
    "accountRegionCode": "SG"
  }
}

参数	描述
id	与该响应关联的消息 ID
jsonrpc	固定为 "2.0"，符合 JSON-RPC 标准
result	表示请求成功的对象
result.username	玩家用户名、昵称或其他可用作用户身份确认的标识，用于帮助用户确认正在为正确的账户充值。例如，唯一的玩家 ID 可能是 “123456789”，其用户名（不一定唯一）可能是 “Terminator123”。
result.roleList	列出用户账户下的所有角色或子账户（如适用）
result.roleList.roleName	角色名称
result.roleList.roleId	角色 ID
result.merchantTransactionId	（可选）由合作伙伴生成的唯一订单号
result.accountRegionCode	注意：accountRegionCode 必须以 2 位国家代码的 ISO 标准返回。这将是创建 userId 的账户所属地区名称。 例如：TH 代表泰国，SG 代表新加坡 https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

无效的验证响应

格式：JSON-RPC

// 
{
    "id": "6164695159717629913",
    "jsonrpc": "2.0",
    "error": {
        "code": -100,
        "message": "Invalid user ID"
    }
}

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