API 付款
大约 8 分钟
请求
付款API使商户能够向各种利益相关者发起安全高效的付款交易,包括员工、客户、供应商和合作伙伴。
支持的付款方式包括:
银行转账(NEFT、RTGS、IMPS)
UPI转账
数字钱包
其他数字支付渠道
请求路径:
沙盒:
https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
生产:https://gateway.smilepayz.com/v2.0/disbursement/pay-out
请求头参数
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
Content-Type | M | String | HTTP内容类型规范 固定值:application/json 正确解析请求所必需 |
X-TIMESTAMP | M | String | ISO 8601日期时间格式,带时区偏移 格式:yyyy-MM-ddTHH:mm:ss±HH:mm 示例:2020-12-17T10:55:00+05:30 注意:必须是当前服务器时间,误差在±5分钟内 |
X-SIGNATURE | M | String | 请求认证的数字签名 参见签名生成 |
X-PARTNER-ID | M | String | 平台分配的唯一商户标识符 格式:字母数字字符串 用于商户认证和交易路由 请输入merchantID |
请求体参数
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
orderNo | M | String(32) | 商户跟踪的唯一交易标识符 格式:仅字母数字字符 长度:6-32个字符 在商户范围内必须是唯一的 |
purpose | M | String(64) | 人类可读的交易描述 格式:UTF-8编码字符串 长度:1-64个字符 用于交易历史和报告 |
merchant | M | Object | 商户识别和业务信息容器 包含主要和子商户详情 交易路由和结算所必需 |
merchantId | M | String | 平台分配的主要商户标识符 格式:字母数字字符串 用于交易路由和结算处理 |
merchantName | O | String | 商户的注册业务名称 格式:UTF-8编码字符串 在支付界面和交易记录中显示 |
subMerchantId | O | String | 多级商户结构的子商户标识符 格式:字母数字字符串 子商户交易处理所必需 |
subMerchantName | O | String | 用于显示的子商户业务名称 格式:UTF-8编码字符串 在支付界面和交易记录中显示 |
money | M | Object | 交易金额和货币规格容器 定义支付价值和货币单位 支付处理和结算所必需 |
currency | M | String | ISO 4217货币代码规范 固定值:INR(印度卢比) 确定支付处理规则和结算货币 |
amount | M | Number | 最小货币单位的交易金额 格式:整数值 示例:200表示INR 200.00 范围:100-999999999 |
paymentMethod | M | String(6) | 印度付款的支付方式规范 格式:预定义支付方式代码 示例:YES、HDFC、SBI 参见支付方式列表 |
cashAccount | M | String(32) | 付款的收款人银行账户号 格式:字母数字字符串 最大长度:32个字符 用于银行转账处理 |
ifscCode | M | String(16) | 印度金融系统代码,用于银行识别 格式:11位字母数字字符串 示例:YESB0000097、HDFC0000001 印度银行转账所必需 |
receiver | M | Object | 收款人信息容器 包含付款的受益人详情 支付处理和合规所必需 |
name | M | String | 付款处理的收款人全名 格式:UTF-8编码字符串 用于支付验证和交易记录 |
callbackUrl | O | String(256) | Webhook通知端点URL 格式:有效的HTTP/HTTPS URL 最大长度:256个字符 接收实时交易状态更新 |
重要说明
1. 银行账户验证: 确保cashAccount
和ifscCode
组合有效,以便成功付款
2. IFSC代码要求: IFSC代码必须正好11个字符,并对应有效的印度银行分行
3. 货币规范: 所有交易必须使用INR(印度卢比)作为货币
4. 支付方式支持: 付款仅支持印度银行和支付方式
请求体示例 – 付款请求:
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+05:30
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001
{
"ifscCode": "YESB0000097",
"cashAccount": "1234567890",
"merchant": {
"merchantId": "20019"
},
"receiver": {
"name": "testName"
},
"money": {
"amount": 10000,
"currency": "INR"
},
"orderNo": "20019a069b102-455d-41e8-9428-dac",
"paymentMethod": "YES",
"purpose": "Java SDK付款目的"
}
响应
HTTP响应
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
Content-Type | M | String | HTTP响应内容类型规范 固定值:application/json 指示JSON响应格式 |
X-TIMESTAMP | M | String | ISO 8601日期时间格式,带时区偏移 格式:yyyy-MM-ddTHH:mm:ss±HH:mm 示例:2020-12-17T10:55:00+05:30 |
响应体参数
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
code | M | String | API响应状态码,指示操作结果 格式:两位数字字符串 成功:"00",错误:其他代码 用于程序化响应处理 |
message | M | String | 人类可读的响应状态描述 格式:UTF-8编码字符串 提供操作结果的详细信息 根据请求语言本地化 |
orderNo | M | String | 用于参考的原始商户交易标识符 格式:与请求orderNo相同 用于交易跟踪和对账 |
merchant | M | Object | 包含账户详情的商户信息容器 包含商户识别和账户信息 参见商户模型 |
merchantId | M | String | 平台分配的主要商户标识符 格式:字母数字字符串 用于交易路由和结算处理 |
merchantName | O | String | 商户的注册业务名称 格式:UTF-8编码字符串 在支付界面和交易记录中显示 |
subMerchantId | O | String | 多级商户结构的子商户标识符 格式:字母数字字符串 子商户交易处理所必需 |
subMerchantName | O | String | 用于显示的子商户业务名称 格式:UTF-8编码字符串 在支付界面和交易记录中显示 |
money | M | Object | 交易金额详情,带货币规格 包含确认的支付金额和货币 参见货币模型 |
currency | M | String | ISO 4217货币代码规范 固定值:INR(印度卢比) 确定支付处理规则和结算货币 |
amount | M | Number | 最小货币单位的交易金额 格式:整数值 示例:200表示INR 200.00 范围:100-999999999 |
disbursementTime | M | String | ISO 8601日期时间格式(yyyy-MM-ddTHH:mm:ss±HH:mm) 示例:2020-12-17T10:55:00+05:30 系统处理付款的时间戳 |
channel | M | Object | 付款处理渠道详情 包含支付方式和账户信息 参见渠道模型 |
cashAccount | M | String | 付款的收款人银行账户号 格式:字母数字字符串 最大长度:32个字符 用于银行转账处理 |
paymentMethod | M | Number | 印度付款的支付方式规范 格式:预定义支付方式代码 示例:YES、HDFC、SBI 参见支付方式列表 |
tradeNo | O | String | 系统跟踪的内部交易参考号 格式:系统生成的字母数字字符串 用于内部交易管理和支持 |
status | O | String | 当前交易处理状态 格式:预定义状态代码 示例:PROCESSING、SUCCESS、FAILED 参见状态模型 |
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+05:30
{
"channel": {
"cashAccount": "123456789",
"paymentMethod": "YES"
},
"code": "00",
"disbursementTime": "2024-12-13T13:31:11+05:30",
"merchant": {
"accountNo": "21220019202402271029",
"merchantId": "20019",
"merchantName": "20019"
},
"message": "成功",
"money": {
"amount": 2000,
"currency": "INR"
},
"orderNo": "20019ae81ede6-07bb-4c77-9937-658",
"status": "PROCESSING",
"tradeNo": "122200192412131501111816"
}
通知/回调
HTTP请求
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
Content-Type | M | String | HTTP通知内容类型规范 固定值:application/json 指示JSON负载格式 |
X-TIMESTAMP | M | String | ISO 8601日期时间格式,带时区偏移 格式:yyyy-MM-ddTHH:mm:ss±HH:mm 示例:2020-12-17T10:55:00+05:30 |
X-SIGNATURE | M | String | 通知验证的数字签名 格式:Base64编码签名 用于验证通知真实性 参见如何检查此值 |
通知体参数
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
orderNo | M | String | 用于参考的原始商户交易标识符 格式:与请求orderNo相同 用于交易对账和跟踪 |
tradeNo | M | String | 系统跟踪的内部交易参考号 格式:系统生成的字母数字字符串 用于内部交易管理和支持 |
merchantId | M | String | 交易路由的主要商户标识符 格式:字母数字字符串 用于商户识别和结算处理 |
merchantName | M | String | 用于显示的注册商户业务名称 格式:UTF-8编码字符串 在交易记录和报告中显示 |
subMerchantId | O | String | 多级结构的子商户标识符 格式:字母数字字符串 当子商户参与交易时包含 |
subMerchantName | O | String | 用于显示的子商户业务名称 格式:UTF-8编码字符串 当子商户参与交易时包含 |
paymentMethod | M | String | 用于交易处理的支付方式 格式:预定义支付方式代码 示例:YES、HDFC、SBI 指示实际使用的支付渠道 |
transactionTime | M | String | ISO 8601日期时间格式(yyyy-MM-ddTHH:mm:ss) 支付提供商完成交易的时间戳 |
status | M | String | 最终交易处理状态 格式:预定义状态代码 示例:SUCCESS、FAILED 指示交易的最终结果 参见状态模型 |
money | M | Object | 最终交易金额详情,带货币 包含确认的支付金额和货币 可能因费用或调整而与请求金额不同 参见货币模型 |
currency | M | String | ISO 4217货币代码规范 固定值:INR(印度卢比) 确定支付处理规则和结算货币 |
amount | M | Number | 最小货币单位的交易金额 格式:整数值 示例:200表示INR 200.00 范围:100-999999999 |
返回
重要
通知请仅返回字符串SUCCESS