API 文档

# 聚合收银台支付API文档

# 1. 如何获取API Key

  用户登录收银台 -> 开发者中心 -> API Key -> 创建API key。API Key 都有单独的配置页，并绑定固定的 IP 地址（“0.0.0.0”表示不做 IP 拦截过滤，任何IP都可以访问），可配置不同的 API Key 满足不同的需求。请不要泄露您的 Access Key 及 Secret Key，以免造成资产损失。Secret Key 生成后将无法再次查看，请注意及时保存，如您忘记了 Secret Key，请在商户后台回收该密钥对并申请新的密钥对。

# 1.1 如何创建API KEY

• 点击开发者中心-API Key

• 1选择是否开启调试模式 ( 开启调试模式后，你有任何错误会有规范的提示信息和日志查看地址 ）

• 2选择API Key权限

• 3输入白名单地址 (0.0.0.0 表示任意IP地址可以访问)

注：( 输⼊⽩名单域名时应注意多个IP时用","隔离。)

• 4点击创建，可⽣成API KEY

(⽣成API KEY后可以在下⽅我的API KEY列表进⾏复制、查看、编辑和删除等操作，注意Secret key只在生成的时候出现一次，请妥善保存，如您忘记了Secret Key,请回收该密钥对并申请新的密钥对。)

• 点击编辑可关闭或开启【开始调试】及修改API Key权限和白名单地址，修改完成后点击保存即可

注意：创建或编辑API Key之后请耐心等待90秒API Key生效

# 2. 如何使用API Key

当前API Key是在请求的Header中添加参数列表

参数名 参数说明 类型 是否必须
access_key Api Key 访问密钥 （如：TPhoa7ZQ） String 是
timestamp 毫秒级时间戳（13位 如：1679669488472） String 是
nonce UUID（36位 如：02f7a04f-53cc-47d4-bb3f-fae69dab49ac） 五个部分分别为8个字符、4个字符、4个字符、4个字符、12个字符，中间用“-”号间隔 String 是
sign 参数签名 （如：GXx2wYUD6UVr+zcmeCSFFPzcBLA=） String 是

# 3. 技术侧参数接入流程

# 4. 如何接口签名

# 签名说明

  API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保请求未被更改，除公共接口（基础信息，行情数据等）外的私有接口均必须使用您的 API Key 做签名认证，以校验参数或参数值在传输途中是否发生了更改。

一个合法的请求由以下几部分组成：

  • access_key： API 访问密钥；
  • secret_key： 签名加密所使用的密钥（仅在后台申请 API Key 时可见一次，请复制保存在安全处，不可泄露）；
  • timestamp： 您发出请求的时间 (UTC 时间) 。如：1632811287325（13位）。在查询请求中包含此值有助于防止第三方截取您的请求；
  • nonce： 随机 UUID 字符串。如：053a1b81-48a0-4bb1-96b2-60f6e509d911（36位）；
  • sign： 签名计算得出的值，用于确保签名有效和未被篡改；
  • 所有接口都需要在http请求头 （header） 中传递以上除 secret_key 外的几个公共参数，公共参数包含（access_key ，timestamp，nonce，sign）其他涉及到签名参数以API接口说明为准 。

# 签名步骤

​ 1.定义一个 Map 字典类型对象，将请求中的参数以 key-value 的形式放入其中

​ 2.将 access_key、timestamp、nonce 也放入第一步定义的 Map 中

​ 3.将 Map 里面的属性按照 ASCII 码从小到大排序（字典序）并将 Map 转换输出为“key1=value1&key2=value2” 形式的字符串

​ 4.将上一步转换的字符串用 secret_key 进行 HMAC_SHA1 加密并进行 Base64 转码，得到 sign 参数值。secret_key 是在收银平台创建的 apikey 中的信息

​ 5.将 sign 值和其他所需参数加到请求头 header 中，发送请求目标接口

# 签名调试工具

  • SignUtil: 用户登录收银台 -> 开发者中心 -> API 文档 -> 签名工具 打开签名工具页面 (工具中的access_key请使用有效的access_key 并且请设置允许这个access_key访问的IP白名单为 0.0.0.0,我们强烈推荐使用过的access_key调试完成后废弃)

# 5. 接口列表

# 5.1 测试接口连通性

请求方式

Get

请求URL

/ping

响应数据

{"version":"1.0.1","timestamp":1688116827306}

响应参数说明

Param Type Desc
version String 返回该参数则本文档中所有接口都可正常请求
timestamp int64 Unix时间戳

# 5.2 新建代收订单

请求方式

Post

请求URL

/api/v3/polymerize/createCollectingOrder

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求参数

{
    "externalOrderId":"3333212121213",
    "notifyUrl":"http://192.168.1.106:9999/callback",
    "remark":"wsxtest",
    "returnUrl":"http://192.168.1.106:9999/callback",
    "userIdentity":"2348937596",
    "dynamicAmountNotify":1
}

请求参数说明

Param Desc Sample Require
externalOrderId 商户订单号 max=64 （String） 389508808434869257 required
notifyUrl 回调地址 （String，Url） http://192.168.1.106:9999/callback optional
remark 备注 max=255（String） 1312425 optional
returnUrl 返回地址 （String） http://192.168.1.106:9999/callback optional
userIdentity 法币-巴西保留后续收银台中用户录入的CPF信息，并以一个字符串ID作为映射，如果传过来的字符串ID匹配到相应CPF则使用已经存储的CPF直接提交订单 这个参数只要开启 如果已经保存过了直接跳过CPF输入 没有保存则需要用户手工录入（不传该字段，系统默认生成CPF）（String） 2348937596 optional
dynamicAmountNotify 法币- 墨西哥币种 是否开启动态金额回调 默认为1 根据实际情况选择1或2 optional

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": "https://cashier.hambit.io?data=eyJjYXNoaWVyRXhwaXJlVGltZUJ5TWludXRlIjo0MCwiZXh0ZXJuYWxPcmRlcklkIjoiMzMzMzIxMjEyMTIxMyIsIm5vdGlmeVVybCI6Imh0dHA6Ly8xOTIuMTY4LjEuMTA2Ojk5OTkvY2FsbGJhY2siLCJyZW1hcmsiOiJ3c3h0ZXN0IiwicmV0dXJuVXJsIjoiaHR0cDovLzE5Mi4xNjguMS4xMDY6OTk5OS9jYWxsYmFjayIsInVzZXJJZGVudGl0eSI6IjIzNDg5Mzc1OTYiLCJ2ZXJzaW9uIjoidjEiLCJpc0hpZGRlbk1lcmNoYW50TG9nbyI6dHJ1ZSwiaXNIaWRkZW5NZXJjaGFudE5hbWUiOnRydWUsImNsaWVudElkIjoiZ0hvUmN3MDMiLCJtZXJjaGFudElkIjoiMTc4NTk0NTgxMTk3NjE5NjA5NyIsInN1Y2Nlc3NSZWRpcmVjdFVybCI6Imh0dHA6Ly8xOTIuMTY4LjEuMTA2Ojk5OTkvY2FsbGJhY2siLCJjcmVhdGlvblRpbWUiOiIxNzI3MjQ3ODI1IiwiZHluYW1pY0Ftb3VudE5vdGlmeSI6MX0%3D"
}

响应参数说明

Param Type Desc
data String 聚合收银台地址

# 6. 回调信息

# 6.1 如何回调接口验签

# 验签说明

​ API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保回调未被更改， 您可设置回调参数签名认证。设置方法为：登录收银台 ->开发者中心 -> 回调地址 -> 添加。

# 验签步骤

整体流程和签名大体一致，仅仅是拿来验签的数据取法不一样，签名是自己构造数据，验签是获取数据（header、json）

  1. 取出 header 中的 sign 值；

  2. 定义一个 Map 字典类型对象，将请求中的json参数以 key-value 的形式放入其中

  3. 取出 header 中的 access_key、timestamp、nonce 也放入上一步定义的 Map 中

  4. 将 Map 中的 key 按照 ASCII 码从小到大排序（字典序）并将 Map 转换输出为“key1=value1&key2=value2” 形式的字符串；

  5. 将上一步转换的字符串用 secret_key 进行 HMAC_SHA1 加密并进行 Base64 转码，得到 sign 签名值与第一步 header 中取出的 sign 进行字符串校验，相符则验签通过，反之则验签失败。此处的 secret_key 需与下单时的 access_key 相匹配。

# 6.2 法币支付回调

回调数据

{
	"currencyType": "BRL",
	"orderActualAmount": "21.1",
	"orderId": "OCURRPAID202307270345431690429543531DOCKER020000000400000776",
	"orderFee": "0.1",
	"orderStatus": "Payment success",
	"payParam": "00020101021226580014BR.GOV.BCB.PIX01367469e5e5-ad5b-43d4-9cf0-07125c89dd8d520400005303986540521.105802BR5925LIQUIDO BRL PAGAMENTOS DI6014Belo Horizonte61083038040362290525dWH1ySiuFwduurQpP1wv7RTof6304BC7A",
	"externalOrderId": "828905760411449635",
	"tradeNote": "123",
	"payTypeName": "PIX",
	"orderAmount": "21.1",
	"orderTime": 1690429544000,
	"payType": 101,
	"orderStatusCode": 2,
	"markStatus": 0,
	"orderPayTime": 1690429623000
}

回调数据说明

Param Type Desc
currencyType String 法币类型
orderActualAmount String 订单实际支付金额
orderId String 订单ID
orderFee String 订单手续费
orderStatus String orderStatusCode描述
payParam String 支付参数
externalOrderId String 商户订单ID
tradeNote String 备注
payTypeName String 支付类型名称
orderAmount String 订单金额
orderTime int64 订单创建时间
payType int64 支付类型：
101-PIX
102-BANK
110-OXXO
111-CASH
103-PIX_DYNAMIC
109-BOLETO
118-GEN
104-VIRTUA
106-EWALLET
105-QRIS
123-UPI
124-IMPS
107-CHARGE
112-WALLET
113-BANK_SCAN_CODE
114-CARD_TO_CARD
115-MOMO
115-ZALO_PAY
117-VIETTEL_MONEY
orderStatusCode int64 订单状态 code 1-待支付
2- 支付成功
markStatus int64 标记状态
orderPayTime int64 订单支付时间
errorMsg String 错误信息
errorMsgEn String 错误信息en

# 6.3 加密支付回调

回调数据

{
	"currencyType": "USD",
	"orderActualAmount": "1",
	"orderId": "OCRYPPAID202307310902391690794159441DOCKER020000000400001108",
	"tradeHash": "0x806d5b3da29c8426a644e2ded85b865b37504dcdec4cfb9db13af5e962815528",
	"orderFee": "1",
	"orderStatus": "Completed",
	"chainType": "ETH",
	"externalOrderId": "402297358314559082",
	"addressTo": "0xe072c63c1e04f8c6f36133f6629f66778147d5d8",
	"orderAmount": "1",
	"orderTime": 1690794159000,
	"exchangeRate": "0.983",
	"orderStatusCode": 4,
	"orderPayTime": 1690794247000,
	"addressFrom": "0x0cbfd17ae9e1d6d881b2cade71277f48abf64d24",
	"tokenType": "USDT"
}

回调参数说明

Param Type Desc
currencyType String 法币类型
orderActualAmount String 订单实际支付金额
orderId String 订单ID
tradeHash String 链上hash
orderFee String 订单手续费
orderStatus String 订单状态code描述
chainType String 主链类型
externalOrderId String 商户订单ID
addressTo String 收款地址
orderAmount String 订单金额
orderTime int64 订单创建时间
exchangeRate String 订单生成时汇率
orderStatusCode int64 订单状态 1-待支付
2-链上确认中
4-已完成
8-支付金额不匹配
16-超时收款
32-未支付订单时间
orderPayTime int64 订单支付时间
addressFrom String 出款地址
tokenType String 代币类型

任意时候商户都可登录商户后台进行手动触发回调（不建议订单非终态发起手动回调），回调信息中订单状态等相关信息为真实实际状态（手动 回调请一定注意订单状态，如果手动回调订单的状态不是终态，在订单变为终态的时候平台依然会发起通知，请注意业务层面的冗余处理）

​ 任意时候商户都可登录商户后台进行手动触发回调（不建议订单非终态发起手动回调），回调信息中订单状态等相关信息为真实实际状态（手动 回调请一定注意订单状态，如果手动回调订单的状态不是终态，在订单变为终态的时候平台依然会发起通知，请注意业务层面的冗余处理）

# 6.4 回调响应

备注：所有的回调都包含签名信息，建议商户做回调验签，商户收到回调信息后，确定订单终态，请响应网

关如下信息（content-type: application/json）如果没有正常响应服务端会在30分钟内，间隔三分钟总计2

次通知

{"code":200,"success":true}

# 6.5 回调通知URL

登录商户后台可以配置统一回调地址（订单中手动指定回调UR地址，优先级高于统一配置的回调地址，例如：订单中指定了notifyUrl参数，不管是否有统一配置回调通知地址，都使用订单中的notifyUrl地址)

注意 http响应status_code优先级最高 只要收到响应status_code=200 响应数据则忽略

# 7. 公共响应代码

filed Type Default value and comment
code String 成功"200" 其他请参考失败code
success Bool 成功 true 失败false 和code保持意义上的同步
msg String 一级code返回的文字性描述
data Object 参考接口列表章节

# 8. 失败code

Code Desc
200 成功
300 参数异常
301 IP无权限
307 签名错误
500 系统错误