创建代付订单

该接口由 FuturePay 团队开发,主要用于发起代付请求,支持向指定收款账户进行付款操作。调用方可通过此接口创建一笔新的代付订单,系统将按配置的代付渠道进行处理与分发。 接口支持参数校验、签名验证及回调通知,适用于各类业务系统对接企业付款、结算、代发工资等场景。

1.请求地址(POST)

实时 API: https://api.futurepay.global/api/v1/payout/pay

沙盒 API: https://api.futurepay-develop.com/api/v1/payout/pay

认证方式:Bearer Token(需在Header中携带Authorization)

2.请求参数

参数名类型是否必填描述
merchantReferencestring商户侧订单号,需保证唯一
beneficiaryNamestring收款人姓名
accountNumberstring收款账户号码(账号格式要求请参考下方列表)
bankNamestring开户银行名称
bankCodestring银行代码(请联系Futurepay团队获取)
payoutTypestring代付类型(如 walletbanktransfer
payoutMethodstring付款方式(如 Nuban更多付款方式请参考付款方式列表)
countryCodestring收款国家二字码(ISO标准,支持国家代码请参考付款方式列表)
addressesobject收款人地址信息
  ↳ line1string地址第一行
  ↳ line2string地址第二行
  ↳ citystring城市
  ↳ statestring省/州
  ↳ countryCodestring国家代码二字码(ISO标准)
  ↳ postalCodestring邮政编码
emailstring收款人邮箱
contactNumberobject收款人联系电话
  ↳ countryCodestring国家区号(如 +86)
  ↳ numberstring电话号码
identificationstring收款人身份证号或护照号
dateOfBirthstring收款人出生日期,格式:yyyy-MM-dd
remitterstring付款人姓名
remitterPhoneNumstring付款人联系电话
remitterAddressstring付款人地址
amountBigDecimal打款金额
currencystring币种(如 AED、NGN、USD)
accountTypestring账户类型(如个人 individual 或公司 company
narrationstring付款说明
clientIpstring客户端 IP,用于风控与日志记录
returnUrlstring付款完成重定向地址
{
  "merchantReference": "MCH123456789",
  "beneficiaryName": "张三",
  "accountNumber": "6222021234567890",
  "bankName": "中国银行",
  "bankCode": "BOC123",
  "payoutType": "wallet",
  "payoutMethod": "Nuban",
  "countryCode": "HM",
  "addresses": {
    "line1": "北京市朝阳区建国门外大街甲6号",
    "line2": "中环世贸C座1201",
    "city": "北京",
    "state": "北京市",
    "countryCode": "CN",
    "postalCode": "100022"
  },
  "email": "[email protected]",
  "contactNumber": {
    "countryCode": "+86",
    "number": "13800138000"
  },
  "identification": "110101199001011234",
  "dateOfBirth": "1990-01-01",
  "remitter": "李四",
  "remitterPhoneNum": "+86-13900139000",
  "remitterAddress": "上海市浦东新区世纪大道88号",
  "amount": 1000.00,
  "currency": "AED",
  "accountType": "company",
  "narration": "工资发放",
  "merchantId":1,
  "clientIp":"127.0.0.1"
}

3.API响应错误内容

字段名类型描述
codestring错误码/成功码(业务码)详情请见下错误码表格
msgstring提示信息
serverTimelong响应生成时间戳(毫秒)
successboolean请求是否成功,false 表示失败
{
    "code": "600006",
    "msg": "Payment failed.",
    "serverTime": 1748260895368,
    "success": false
}

3.1 错误码

错误码含义说明(英文 msg)中文注释
600001Merchant is now invalid - Contact futurepay to enable the account.商户已失效,请联系 Futurepay 启用账号
600002The payout product for this account is not yet enabled - Please contact Futurepay to activate it.当前商户尚未开通代付产品,请联系 Futurepay
600003MerchantReference should be unique for each transaction.商户订单号需全局唯一
600004Unsupported country.不支持的国家代码
600005Unsupported currency.不支持的币种
600006Payment failed.代付请求失败
600007Missing Required Arguments.缺少必要参数
600008Insufficient Balance.商户余额不足
600009Failed to freeze the available balance of the merchant.商户余额冻结失败
600010The fee strategy has not been configured - Contact futurepay for configuration.手续费策略未配置,请联系 Futurepay
600011Failed to obtain the order rate.获取费率失败
600012Failed to notify the merchant.商户通知失败
600013Payout order not found.代付订单不存在

4.正确响应内容

字段名类型说明示例值
merchantReferenceString商户请求的唯一订单号MCH123456789
pspReferenceString平台生成的订单编号(用于平台追踪)FP202405270001
resultCodeString订单状态码(如:SUCCESS、FAILED)SUCCESS
dataObject支付明细数据
├─ paymentAmountObject实际付款总金额(付款金额 + 手续费)
│ ├─ currencyString支付币种AED
│ └─ valueString金额,单位保留两位小数(字符串格式)1050.00
├─ payeeAmountObject收款方应收金额(不含手续费)
│ ├─ currencyString币种AED
│ └─ valueString金额1000.00
└─ feeAmountObject手续费金额
├─ currencyString币种AED
└─ valueString金额`50.00
{
  "merchantReference": "MCH123456789",
  "pspReference": "FP202405270001",
  "resultCode": "SUCCESS",
  "data": {
    "paymentAmount": {
      "currency": "AED",
      "value": "1050.00"
    },
    "payeeAmount": {
      "currency": "AED",
      "value": "1000.00"
    },
    "feeAmount": {
      "currency": "AED",
      "value": "50.00"
    }
  }
}

5.付款方式说明列表

付款方式枚举付款支持的国家支持的币种
NubanNG(尼日利亚)NGN
MobileMoneyGH(加纳)、KE(肯尼亚)、TZ(坦桑尼亚)、UG(乌干达)、BJ(贝宁)、CI(科特迪瓦)、CM(喀麦隆)GHS、KES、TZS、UGX、XOF、XAF
GhippsGH(加纳)GHS
TissTZ(坦桑尼亚)TZS
KepssKE(肯尼亚)KES
WaveCI(科特迪瓦)XOF

收款账号格式要求

付款方式枚举国家代码(中文)币种收款账号格式说明示例账号
NubanNG(尼日利亚)NGN10位数字1234567890
KepssKE(肯尼亚)KES10位数字1234567890
MobileMoneyGH(加纳)GHS12位数字,以国家代码233开头233XXXXXXXXX
MobileMoneyKE(肯尼亚)KES12位数字,以国家代码254开头254XXXXXXXXX
MobileMoneyUG(乌干达)UGX12位数字,以国家代码256开头256XXXXXXXXX
MobileMoneyTZ(坦桑尼亚)TZS12位数字,以国家代码255开头255XXXXXXXXX
MobileMoneyBJ(贝宁)XOF12位数字,以国家代码229开头229XXXXXXXXX
MobileMoneyCI(科特迪瓦)XOF12位数字,以国家代码225开头225XXXXXXXXX
MobileMoneyCM(喀麦隆)XAF12位数字,以国家代码237开头237XXXXXXXXX
GhippsGH(加纳)GHS具体格式视银行规则(通常为银行账户号)(依银行规则)
TissTZ(坦桑尼亚)TZS具体格式视银行规则(通常为银行账户号)(依银行规则)
WaveCI(科特迪瓦)XOF12位数字,以国家代码225开头225XXXXXXXXX