API 付款

请求

付款API使商户能够向收款人发起资金付款交易。
支持的付款方式包括：

银行转账
数字钱包
虚拟账户
其他电子支付渠道

请求路径：

沙盒：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+07:00 注意：必须是当前服务器时间，误差在±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货币代码规范固定值：IDR（印尼盾）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额（仙）格式：整数值示例：20000表示IDR 20000 范围：10000-999999999
paymentMethod	M	String(6)	付款方式规范格式：预定义支付方式代码示例：BRI、BCA、DANA、OVO 确定使用的付款渠道
cashAccount	M	String(32)	资金付款的收款人账户标识符格式：银行账户号码或电子钱包账户示例：银行账户（78120011629261665）、DANA钱包（8xxxxxxx）必须是有效且活跃的账户才能成功转账
callbackUrl	O	String(256)	Webhook通知端点URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符接收实时交易状态更新

重要格式要求

DANA钱包账户格式： 对于DANA钱包付款，确保cashAccount遵循8xxxxxxx格式

请求体示例 – 付款请求：

POST {Base URL}/v2.0/disbursement/pay-out HTTP/1.2

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "additionalParam": {},
    "cashAccount": "78120011629261665",
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 10000,
        "currency": "IDR"
    },
    "orderNo": "2000102900000000000001",
    "paymentMethod": "BRI",
    "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+07:00

响应体参数

字段	必填	类型	描述
code	M	String	API响应状态码，指示操作结果格式：两位数字字符串成功："00"，错误：其他代码用于程序化响应处理
message	M	String	人类可读的响应状态描述格式：UTF-8编码字符串提供操作结果的详细信息根据请求语言本地化
orderNo	M	String	用于参考的原始商户交易标识符格式：与请求orderNo相同用于交易跟踪和对账
tradeNo	O	String	系统跟踪的内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
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货币代码规范固定值：IDR（印尼盾）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：20000表示IDR 20000 范围：10000-999999999
disbursementTime	M	String	ISO 8601日期时间格式（yyyy-MM-ddTHH:mm:ss±HH:mm）示例：2020-12-17T10:55:00+07:00 系统处理付款的时间戳
channel	M	Object	付款处理渠道详情包含支付方式、账户信息和收款人详情用于交易跟踪和收款人验证
paymentMethod	O	String	首选支付方式规范格式：预定义支付方式代码示例：QRIS、W_DANA、CIMB、BCA 如果省略，将显示支付方式选择页面
cashAccount	O	String	付款处理的收款人账户号码格式：字母数字字符串用于向收款人账户转账示例：78120011629261665
accountName	O	String	用于验证的收款人账户持有人姓名格式：UTF-8编码字符串用于收款人识别和验证示例：Betty
status	O	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING、SUCCESS、FAILED 参见状态模型

响应体示例 – 交易响应：

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
  "code": "00",
  "message": "成功",
  "orderNo": "2000102900000000000001",
  "tradeNo": "1022000109e998347483949",
  "status": "PROCESSING",
  "disbursementTime": "2020-12-17T10:55:00+07:00",
  "merchant": {
    "merchantId": "20001",
    "merchantName": "test",
    "accountNo": "2000124234782342"
  },
  "money": {
    "currency": "IDR",
    "amount": 10000
  },
  "channel": {
    "paymentMethod": "BRI",
    "cashAccount": "78120011629261665",
    "accountName": "Betty"
  }
}

通知/回调

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+07:00
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	用于交易处理的付款方式格式：预定义支付方式代码示例：BRI、BCA、DANA、OVO 指示实际使用的付款渠道
transactionTime	M	String	ISO 8601日期时间格式，带时区偏移日期时间格式（yyyy-MM-ddTHH:mm:ss±HH:mm）支付提供商完成付款的时间戳
money	M	Object	最终交易金额详情，带货币包含确认的付款金额和货币可能因费用或调整而与请求金额不同参见货币模型
currency	M	String	ISO 4217货币代码规范固定值：IDR（印尼盾）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：20000表示IDR 20000 范围：10000-999999999
status	M	String	最终交易处理状态格式：预定义状态代码示例：SUCCESS、FAILED 指示付款的最终结果参见状态模型

重要

通知请仅返回字符串SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 10000.0000,
    "currency": "IDR"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "1022000109e998347483949",
  "transactionTime": "2020-12-17T10:55:00+07:00"
}

SUCCESS

API 付款

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

# 请求体示例 – 付款请求：

# 响应

# HTTP请求

# 响应体参数

# 响应体示例 – 交易响应：

# 通知/回调

# HTTP请求

# 通知体参数

# 返回

请求

请求路径：

请求头参数

请求体参数

请求体示例 – 付款请求：

响应

HTTP请求

响应体参数

响应体示例 – 交易响应：

通知/回调

HTTP请求

通知体参数

返回