代金券（现金卡）

代金券调用流程

代金券支付方式允许客户在商家的网站通过 Codapay 兑换代金券代码。Codapay 会实时记录已完成的支付，并立即通知商家。有关代金券的详细信息，请参阅请求表中Profile字段的代金券部分。

对于代金券交易，代金券的金额仅在兑换后确认；商家需要验证 Coda API 响应中返回的净金额，并能够处理所有可用面额的兑换。

请求参数

参数	类型	长度	描述
api_key	String	256	必填 Coda提供的API密钥 - 请参考 Codapay 入门指南 了解如何获取。
project_id	String	10	此字段仅适用于 v2.0 API，必填项 由 Coda 提供的 Project ID，对每个标题产品都是唯一的。 请参阅 Codapay 入门指南 了解
order_id	String	64	必填 您在支付请求发起时传递的订单ID
country	Number	N/A	必填 ISO 3166 的国家代码 国家和货币代码
lang	String	2	必填 各个国家的'Lang'选项列表
type	Number	1	1：数字内容物品 2：非数字内容物品
pay_type	Number	1	必填 代金券使用 pay_type = 4。 更多详情请参阅 后端API
pay_channel	Number	3	每个支付渠道的代码。
merchant_name	String	128	可选 如果您希望指定商家名称，请在此字段中输入名称。 默认值为空。
items	ItemInfo	N/A	必填 用户购买的商品列表
items[].code	String	128	必填 商家的商品代码
items[].name	String	128	必填 商品名称，仅支持拉丁字符
items[].price	Number	N/A	必填 已含税的商品价格（已含税），以请求中指定的货币计价
items[].type	Number	N/A	必填 默认值=1
profile	Map	N/A	必填 Profile 字段

Profile 字段

参数	类型	长度	描述
voucher_code	String	20	必填 代金券代码。
voucher_pin	String	20	必填 代金券 PIN。
card_type	String	N/A	可选 默认使用 "card_type":"0"

请求示例

参数	类型	长度	描述
result_code	Number	N/A	ResultCode将帮助指示交易的状态。 ResultCode = 0 表示交易成功。 ResultCode = 431 或 216 表示交易待处理 所有其他ResultCode值表示交易失败。您可以在这里找到完整的错误代码及其解释。
result_desc	String	512	如果resultCode返回错误，则该值描述错误信息。
txn_id	Number	N/A	从支付请求发起返回的Coda订单ID。
txn_timeout	Number	N/A	交易超时时间（分钟）。
total_price	Number	N/A	未格式化的数字值。 对于印度尼西亚、智利、韩国、台湾和越南的货币，不支持小数。
pay_instructions	String	15	如果响应返回了此值，商家应在页面上向客户显示提供的支付指引。
profile	Number	N/A	请参考此处

v2.0 示例

{
  "project_id": "1", //此字段仅适用于 2.0 API
  "country": "410",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "<Your OrderID>",
  "lang": "ko",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "4",
  "pay_channel": "-148",
  "items": [
    {
      "code": "7",
      "name": "Test Item",
      "price": 500.0
    }
  ],
  "profile": {
    "voucher_code": "-",
    "voucher_pin": "-"
  }
}

v1.0 示例

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your Order ID)",
    "lang":"en",
    "merchant_name":"ebooks",
    "pay_type":"4",
    "pay_channel":"340",
    "type":"1",
    "profile":{
        "voucher_code":"12345678901231",
        "voucher_pin":"",
        "card_type":"0",
        "user_id":"12345"
    }
}

响应参数

参数	类型	长度	描述
result_code	Number	N/A	ResultCode将帮助指示交易的状态。 ResultCode = 0 表示交易成功。 错误代码列表请参阅 常见错误代码
result_desc	String	512	如果resultCode返回错误，则该值描述错误信息。
txn_id	Number	N/A	支付请求发起返回的Coda订单ID。
txn_timeout	Number	N/A	交易超时时间（分钟）
total_price	Number	N/A	用户支付的总金额，以本地货币计价。
pay_instructions	String	15	如果响应返回了此值，商家应在页面上向客户显示提供的支付指引。
profile	Number	N/A	请参考 Profile 字段

Profile 字段

参数	类型	长度	描述
redirect_url	String	128	仅当所选支付渠道遵循重定向 URL 流程时，才返回支付网关的重定向 URL。
extInfoByte	String	128	请忽略此字段。
name	String	128	客户姓名。
payment_code	Number	N/A	由支付渠道生成的代码。

响应示例

示例

{
   "txn_id": <Coda Transaction ID>,
   "txn_timeout": 0,
   "result_code": 0,
   "total_price": 150,
   "profile":{"user_id":"12345"}
}

USD 订单交易参考

请查看此指南，了解更多关于 USD 交易的信息。