▶️ 创建代付订单 / Apply for Payout

<aside> 💡

Endpoint: POST /api/agentpay/apply

</aside>

参数名 类型 必填 示例 描述
mchId string ✅ BXtest067 必填项 商户号 / 注意：商户号不为商户ID
mchOrderNo string ✅ 202503110001 必填项 商户订单号
amount int ✅ 10000 必填项 实际金额100,这里需要传10000
currency string ✅ BRL 必填项 币种 / Currency
shape String ✅ PIX_PHONE 必填项 shape = PIX_CPF,PIX_EVP,PIX_EMAIL,PIX_CNPJ,PIX_PHONE
shapeValue String ✅ [email protected] 必填项
cpf 个人税务登记号,
cnpj 法人登记号,
evp 虚拟支付地址,
phone:手机号必须带+55，email:邮箱
notifyUrl string ✅ https://merchant.com/notify 必填项 回调地址
remark string ❌ 代付金额
备注
sign string ✅ 5E0AA05D… 必填项 签名值 / Signature

请求示例 / Request Example

POST /api/agentpay/apply
mchId="BXtest067"
mchOrderNo="202503110001"
amount=10000
currency="BRL"
shape="PIX_EMAIL"
shapeValue="[email protected]"
remark="123123"
buildFlag=true
notifyUrl="http://localhost:8081/api/pay/notifyUrl"
sign="79B1E1C4F3290FBB6CB2FA2CAE2BA67C"

⚠️ SUCCESS 表示订单创建成功，非支付成功。

返回示例 / Response Example

{
    "retCode": "SUCCESS",
    "retMsg": "代付申请成功",
    "agentpayOrderId": "test198311136382210", // 代付订单号
    "fee": 1200,
    "extra": null,
    "status": 0,
    "sign": "106A36489C4B624FD23BF92F4ABF6272"
}

<aside> 💡

状态：0 待处理 ｜ 1 处理中 ｜ 2 成功 ｜ 3 失败 ｜ 4 二次审核｜ 5 审核拒绝｜ 6 冲正

</aside>

▶️ 查询代付订单 / Query Payout Order

<aside> 💡

Endpoint: POST /api/agentpay/query_order

</aside>

参数名 类型 必填 描述
mchId string ✅ 商户号 / 注意：商户号不为商户ID
mchOrderNo String(30) ✅ 商户生成的订单号，与agentpayOrderId二者传一即可
agentpayOrderId String(30) ✅ 交易中心生成的订单号，与mchOrderNo二者传一即可
reqTime String(20) ✅ 请求发起时间,时间格式:yyyyMMddHHmmss
sign String(32) ✅ 签名值，详见签名算法

请求示例 / Request Example

POST /api/agentpay/query_order
mchId="BXtest067"
mchOrderNo="202503110001"
agentpayOrderId="Sv202503110001"
reqTime="20211111"
sign="79B1E1C4F3290FBB6CB2FA2CAE2BA67C"

返回示例 / Response Example

{
"retCode": "SUCCESS",
"mchOrderNo": "AP1538919309174",
"agentpayOrderId": "Sv20160427210604000490",
"amount": 8000,
"status": 2,
"channelPayNo": "E12300000000", // E2E单号
"fee": 3, // 手续费
"voucherMap":{  // 凭证相关信息
        "amount": "3000.000000", // 金额 凭证金额单位为元
        "backgroundColor": "#2D78C0",
        "orderNo": "test1995414377226330113",
        "todayTime": "2025-12-02 02:45:57", // 当前时间
        "mchOrderNo": "njzy41ekbjb",
        "timezone": "America/Sao_Paulo",
        "deductAmount": "3000.000000",
        "channelPayNo": "99999", 
        "channelPayCodeLabelStyleDisplay": "table-row",
        "title": "SeavaPay",
        "channelPayCodeLabel": "E2E Number",
        "createTime": "2025-12-01 05:47:15",
        "accountNo": "payee_code_123",  // 收款人CPF
        "accountName": "payee_name_123", // 收款人名称  
        "bankName": "payee_bank_123",  // 收款人银行
        "payerCode": "payer_123123123", // 付款人CPF
        "payerBank": "payer_bank_123", //付款人银行
        "payerName": "payer_name_123",  //付款人名称 
        "currency": "BRL",
        "channelCode": "10020"
    } // 代付凭证相关信息
"sign": "3B166CA71811D4A0FEC25D511A365ED3"
}

▶️ 获取订单凭证 / Get Order Voucher

<aside> 💡

Endpoint: POST /api/agentpay/voucher

</aside>

参数名 类型 必填 描述
mchId string ✅ 商户号 / 注意：商户号不为商户ID
mchOrderNo String(30) ✅ 商户生成的订单号，与agentpayOrderId二者传一即可
agentpayOrderId String(30) ✅ 交易中心生成的订单号，与mchOrderNo二者传一即可
reqTime String(20) ✅ 请求发起时间,时间格式:yyyyMMddHHmmss
sign String(32) ✅ 签名值，详见签名算法

返回示例

响应类型
Content-Type: image/png
会返回流信息代付凭证图片，为png图片格式