银行转账

银行转账调用流程

客户可以通过在 ATM、银行柜台或使用网上银行执行银行转账来支付订单。商家会在Profile字段中收到一个唯一的支付代码，客户需在银行转账详情中输入该代码。

请求参数

参数	类型	长度	描述
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 = 2。 更多详情请参阅 后端API
pay_channel	Number	3	每个支付渠道的代码。
pay_at	Number	2	此字段指示客户应在哪里完成购买。 1 = 银行柜台 2 = 网络银行 3 = 在线账单支付 4 = 电子钱包 5 = 自动取款机 14 = 便利店
msisdn	Number	15	MSISDN（未格式化；不包含国家代码。 仅在需要 MSISDN 而非电子邮件时包含此项。
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 字段

参数	类型	长度	描述
user_id	String	128	必填 客户的用户 ID
client_ip	String	15	可选 客户的 IP 地址 (仅支持IPv4)
name	String	128	可选 客户姓名
id_no	Number	14	可选 巴西/墨西哥/阿根廷的身份证明文件称为 CPF。

请求示例

以下是一些请求示例：

i. 带有 MSISDN - 印度尼西亚（BCA ATM）

ii. 带有电子邮件 - 土耳其银行转账

iii. 带有 Pay_AT - 银行（巴西 - PIX）

v2.0 请求示例

带msisdn的示例

{
  "project_id": "1", //此字段仅适用于 2.0 API
  "country": "360",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "12345",
  "lang": "en",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "2",
  "pay_channel": "9",
  "pay_at": "5",
  "msisdn": "<Your Number>",
  "items": [
    {
      "code": "1",
      "name": "Test Item",
      "price": 11000.0
    }
  ],
  "profile": {
    "name": "Test Name",
    "user_id": "12345"

  }
}

带email的示例

{
  "project_id": "1", //此字段仅适用于 2.0 API
  "country": "360",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "12345",
  "lang": "en",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "2",
  "pay_channel": "9",
  "email": "[e-mail]",
  "items": [
    {
      "code": "1",
      "name": "Test Item",
      "price": 11000.0
    }
  ],
  "profile": {
    "name": "Test Name",
    "user_id": "12345"

  }
}

带pay_at的示例

{
  "project_id": "1", //此字段仅适用于 2.0 API API
  "country": "360",
  "api_key": "test_e944d44f065eade8157737385a09",
  "order_id": "12345",
  "lang": "en",
  "merchant_name": "Codapay",
  "type": "1",
  "pay_type": "2",
  "pay_channel": "9",
  "email": "[e-mail]",
  "items": [
    {
      "code": "1",
      "name": "Test Item",
      "price": 11000.0
    }
  ],
  "profile": {
    "name": "Test Name",
    "user_id": "12345"

  }
}

v1.0 请求示例

带msisdn的示例

{
    "api_key":"<your api key>",
    "order_id":"<your order id>",
    "lang":"en",
    "merchant_name":"test in Coda",
    "pay_type":"2",
    "pay_channel":"1",
    "type":"1", 
    "msisdn":"<phone number>",
    "items":[{
        "code":"456789",
        "name":"GameCredit",
        "price":100000.00
    }],
    "profile":{
          "name":"test in Coda"}

}

带email的示例

{
    "api_key": "YOUR API KEY",
    "order_id": "123456",
    "lang": "tr",
    "merchant_name": "ebooks",
    "pay_type": "2", 
    "pay_channel": "-86",
    "type": "1",
    "email": "[e-mail]",

    "items": [
        {
            "code": "1",
            "name": "One Day",
            "price": 3
        }
    ],
    "profile":{
            "user_id":"12345"}
}

带pay_at的示例

{
    "api_key":"<YOUR API KEY>",
    "order_id":"<Your OrderID>",
    "lang":"en",
    "merchant_name":"Codapay",
    "pay_type":"2",
    "pay_channel":"153",
    "type":"1",
    "pay_at":"5",
    "email":"[e-mail]",

    "items":[{
           "code":"1",
           "name":"Test Item",
           "price":3.0}],

    "profile":{
           "name":"Test Name",
           "id_no":"12345",
           "dateofbirth":"",
           "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	Object	N/A	请参考 Profile 字段

Profile 字段

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

响应示例

带msisdn的示例

{
    "txn_id": <transaction id>,
    "txn_timeout": 1509,
    "result_code": 0,
    "total_price": 100000.0,
    "pay_instructions": "To complete the purchase by following the provided instruction, Enter the payment code 1900800000828075. Leave the transaction reference blank. Enter the payment amount if needed, your total purchase amount is Rp. 100.000. For more detailed instruction on how to pay, please refer to the payment link.",
   
    "profile": {
        "extInfoByte": "0",
        "paymentCode": "1900800000828075",
        "name": "test in Coda",
        "redirect_url": "https://sample_URL.com",
        "payment_code": "1900800000828075"
    }
}

带email的示例

{
    "txn_id": 1234567890,
    "txn_timeout": 35,
    "result_code": 0,
    "result_desc": null,
    "total_price": 3,
    "pay_instructions": "",

    "profile": {
        "extInfoByte": "0",
        "user_id":"12345",
        "redirect_url": "https:/sample_url.com",
        "payment_code": ""
    }
}

带pay_at的示例

{
  "txn_id":"1234567890",
  "txn_timeout":7209,
  "result_code":431,
  "result_desc":"generic sub header",
  "total_price":3,
  "pay_instructions":"",

  "profile":{
        "zip":"12302",
        "extInfoByte":"1",
        "dateofbirth":"",
        "device_id":"5646e134-3300-4073-8f51-16431857eee0",
        "tax":"10","tax_rate":"10",
        "house_number_or_name":"10",
        "billing_street":"Main Street",
        "billing_city":"New York",
        "id_no":"88899988811",
        "user_id":"Testuser327",
        "name":"Yosep Joestar",
        "billing_address_line_2":"", 
        "state":"NY",
        "redirect_url":"https://sample_url.com",
        "payment_code":""}
}

USD 订单交易参考

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