SasS 公共请求及响应参数
1. 简介
提供Server To Server无人自助售货柜交易接口 给服务商(下述描述机构均为服务商) 调用。
注:涉及金额字段,单位均为元
1.1 接入信息准备
请在对接群中提供以下对接信息(包含测试与生产环境两套):
- 接入方公钥信息(平台用于验 证请求签名)
- 接入方接收回调地址(交易终态结果通知,仅支持统一配置接口回调地址,不支持单次请求配置回调地址)
- IP(接入方调用API的公网IP,平台用于配置白名单)
1.2 接入参数
1.1 接入信息提供之后,由平台进行相关配置,并提供接入参数,主要包含:机构编号、机构密钥证书序列号、商户编号、平台公钥(见 6. 接口签名机制说明)
1.3 Java SDK接入示例
您可以下载我们提供的Java版本接入demo示例:Java SDK Demo
2. 接口地址
| 名称 | 信息 |
|---|---|
| 测试环境地址 | https://payment-test-gw.cogolinks.com |
| 生产环境地址 | https://payment-sg-gw.cogolinks.com |
| 请求方式 | HTTPS |
| 接口公共前缀 | /saas/ |
3. 请求公共参数信息
介绍:包括请求头公共参数(如版本号、语言、接口名称、业务类型、机构编号、机构密钥证书序列号、机构签名、签名方法等)和请求公共参数信息(如请求 ID、请求时间、随机字符串、请求数据等)。
3.1 请求头公共参数信息
| 字段名 | 类型 | 是否必传 | 字段名称 | 说明 |
|---|---|---|---|---|
| interfaceVersion | String | 是 | 版本号 | 默认值:1.0.0 |
| language | String | 否 | 语言 | 语言(zh_CN,zh_TW,en_US)默认取值:zh_CN |
| interfaceName | String | 是 | 接口名称,接口地址中的一级之后内容 | 示例:/pos/auth/capture接口填写:auth/capture |
| businessType | String | 是 | 业务类型,接口地址中的一级内容 | 示例:/pos/auth/capture接口填写:pos |
| orgNo | String | 是 | 机构编号 | |
| orgCertId | String | 是 | 机构密钥证书序列号 | |
| signature | String | 是 | 机构签名 | |
| signMethod | String | 是 | 机构签名方法 取值范围:RSA-SHA256,ECDSA-SHA256,HMAC-SHA256 |
3.2 请求公共参数信息
| 字段名 | 类型 | 是否必传 | 字段名称 | 说明 |
|---|---|---|---|---|
| requestId | String | 是 | 请求ID | 请求唯一标识,调用方生成,用于唯一标识某次具体请求 建议1-36位(例如:机构编号_时间戳_UUID,如ORG001_20231001123000123_9a8b7c6d5e4f) |
| requestTime | Timestamp | 是 | 请求时间 | ISO 8601标准格式(如yyyy-MM-dd'T'HH:mm:ss.SSSXXX),明确时区信息 |
| nonceStr | String | 是 | 随机字符串 | 短时防重放,调用方生成,服务端校验短时间内唯一 建议1-32位 可使用SecureRandom生成高强度随机数 |
| data | Object | 是 | 请求数据 |
4. 响应公共参数信息
介绍:涵盖响应头公共参数(机构密钥证书序列号、机构签名、签名方法)和响应公共参数信息(请求 UUID、请求时间、响应时间、响应码、响应描述、业务主应码、业务主应答信息、业务子应答码、业务子应答信息、响应数据等)
4.1 响应头公共参数信息
| 字段名 | 类型 | 是否必传 | 字段名称 | 说明 |
|---|---|---|---|---|
| orgCertId | String | 是 |