API 付款交易

请求

付款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-03:00 注意：必须是当前服务器时间，误差±5分钟内
X-SIGNATURE	M	String	请求认证的数字签名参见签名生成
X-PARTNER-ID	M	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由请输入merchantID

请求体参数

字段	必需	类型	描述
orderNo	M	String(32)	唯一交易标识符格式：字母数字字符串（仅数字和字母）长度：6-32个字符用于交易跟踪和参考
purpose	M	String(64)	交易目的或描述格式：UTF-8编码字符串最大长度：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货币代码规范固定值：BRL（巴西雷亚尔）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：100表示BRL 100.00 范围：100-999999999
paymentMethod	M	String(6)	支付方式规范格式：预定义支付方式代码示例：CPF、CNPJ、PHONE、EMAIL、EVP 确定支付处理渠道和规则参见支付方式列表
cashAccount	M	String(32)	收款人账户标识符格式：CPF/CNPJ/电话/邮箱/EVP账户号码示例："12532481501"（CPF）、"+5511999999999"（PHONE）用于向收款人发放资金
receiver	M	Object	收款人信息容器包含收款人识别和验证详情参见收款人模型
taxNumber	M	String	收款人税务识别号码格式：CPF（11位数字）或CNPJ（14位数字）示例："12345678909" 用于收款人验证和合规
callbackUrl	O	String(256)	交易状态更新的Webhook通知URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符用于实时交易状态通知
additionalParam	O	Object	额外交易参数格式：JSON对象包含需要时的补充交易详情

请求体示例 – 付款交易请求：

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

{
    "additionalParam": {},
    "cashAccount": "12532481501",
    "receiver": {
        "taxNumber": "12345678909"
    },
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 10000,
        "currency": "BRL"
    },
    "orderNo": "2000102900000000000001",
    "paymentMethod": "CPF",
    "purpose": "Purpose For Disbursement from 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-03:00

响应体参数

字段	必需	类型	描述
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编码字符串用于子商户识别和报告
accountNo	O	String	交易结算的商户账户号码格式：字母数字字符串用于资金分配和结算
money	M	Object	带货币规格的交易金额详情包含确认的交易金额和货币参见金额模型
currency	M	String	ISO 4217货币代码规范固定值：BRL（巴西雷亚尔）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：100表示BRL 100.00 用于精确金额表示
transactionTime	M	String	交易创建时间戳格式：yyyy-MM-ddTHH:mm:ss-03:00（巴西时区）示例：2020-12-17T10:55:00-03:00 用于交易时间和审计
tradeNo	O	String	系统跟踪的内部交易参考号码格式：系统生成的字母数字字符串用于内部交易管理和支持
status	O	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING、SUCCESS、FAILED、CANCELLED 指示交易的当前状态参见状态模型

响应示例

{
    "code": "00",
    "merchant": {
        "accountNo": "11320011202402290943",
        "merchantId": "20001",
        "merchantName": "test"
    },
    "message": "Successful",
    "money": {
        "amount": 10000,
        "currency": "BRL"
    },
    "orderNo": "2000102900000000000001",
    "status": "PROCESSING",
    "tradeNo": "101200012410241325417215",
    "transactionTime": "2020-12-17T10:55:00-03:00"
}

API 付款交易

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

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

# 响应

# HTTP响应

# 响应体参数

# 响应示例

请求

请求路径：

请求头参数

请求体参数

请求体示例 – 付款交易请求：

响应

HTTP响应

响应体参数

响应示例