跳转到主要内容
阅读该接口文档前,务必先查看 接口说明
如有需要,可联系HaiPay将所有的业务密钥配置信息改为同一套

代收API

代收申请

简要描述:
  • 创建代收订单
URL: /global/cashier/collect/apply 说明:appId需使用收银台对应的,用户支付成功后增加[currency]对应的余额 参数:
参数名必选类型说明
appIdLong业务ID(后台获取,请使用收银台专属APPID,币种为收银台(CASHIER))
orderIdString商户订单号(必须保证唯一性,长度不超过48)
nameString用户姓名,推荐使用真实姓名,格式:包含firstName和lastName,以空格分割的,示例:Donald John Trump
emailString真实电子邮件
amountString交易金额(精确到小数点后两位;禁止添加标点符号,例如:”,”)
currencyString交易金额对应的币种,支持:USD(0.99美元起步),其他币种参考地区编码
callBackUrlString用户支付成功后跳转地址
callBackFailUrlString用户支付失败后跳转地址
notifyUrlString回调地址
subjectString支付备注(交易标题,商品名称,支付原因等)
bodyString备注详情
regionString地区编码,使用两位编码即可
partnerUserIdString用户唯一标识(如用户ID userId),用于风控系统,必须真实有效,否则会影响交易。 格式要求:数字、大小写字母或常用符号-~!@#$%&*()_。
signString签名
返回data参数说明
参数名类型说明
orderIdString商户订单号
orderNoString平台订单号
payUrlString支付链接
signString签名

代收查询

简要描述:
  • 代收订单查询
URL: /global/cashier/collect/query 参数:
参数名必选类型说明
appIdLong业务ID(后台获取,请使用收银台专属APPID,币种为收银台(CASHIER))
orderIdString商户订单号
orderNoString平台订单号
signString签名
返回data参数说明
参数名类型说明
orderIdString商户订单号
orderNoString平台订单号
amountString订单金额
actualAmountString实收金额
feeString手续费
statusInteger状态(0未开始,1支付中,2成功(终态),3失败(终态), -1异常待确认)
payTimeString支付成功时间(当status=2时有值)(本地时间), 格式: yyyy-MM-dd HH:mm:ss
errorMsgString支付失败原因(当status=3时有值)
signString签名

代收查询v2

简要描述:
  • 代收订单查询
URL: /global/cashier/collect/query/v2 参数:
参数名必选类型说明
appIdLong业务ID(后台获取,请使用收银台专属APPID,币种为收银台(CASHIER))
orderIdString商户订单号
orderNoString平台订单号
signString签名
返回data参数说明
参数名类型说明
orderIdString商户订单号
orderNoString平台订单号
currencyString币种(选择具体支付方式后有值)
amountString订单金额
actualAmountString实收金额
feeString手续费
statusInteger状态(0未开始,1支付中,2成功(终态),3失败(终态), -1异常待确认)
payTimeString支付成功时间(当status=2时有值)(本地时间), 格式: yyyy-MM-dd HH:mm:ss
errorMsgString支付失败原因(当status=3时有值)
originalCurrencyString实际支付币种
floatExchangeRateString币种转换涉及的汇率
originalAmountString实际支付金额
signString签名

地区编码

参考:ISO 3166-1 alpha-2
编码地区名称支持币种
AEUnited Arab EmiratesAED
ATAustriaEUR
BEBelgiumEUR
BHBahrainBHD
BRBrazilBRL
EGEgyptEGP
GBUnited KingdomGBP
HKHong KongHKD,USD
IDIndonesiaIDR,USD
INIndiaINR
JPJapanJPY,USD
KRSouth KoreaKRW,USD
KWKuwaitKWD
MYMalaysiaMYR,USD
NLNetherlandsEUR
OMOmanOMR
PHPhilippinesPHP
PKPakistanPKR
PLPolandEUR
QAQatarQAR
SASaudi ArabiaSAR
SGSingaporeSGD,USD
THThailandTHB,USD
TRTürkiyeTRY
TWTaiwanTWD,USD
USUnited StatesUSD
VNVietnamVND,USD
ITItalyEUR
EUEuropean UnionEUR
Last modified on April 15, 2026