跳转到主要内容
联调环境请求地址
Testhttps://uat-interface.haipay.asia
Prod上线提供
通过该项目接口定义可在不同环境使用,自主完成下单、支付流程。并通过不断添加用例场景,沉淀、积累用例

接口

代收

代收申请

创建代收订单 URL/{currency}/collect/apply为币种,详情参考 交易支持的国家与币种 请求方式:POST 请求参数:
参数名必选类型说明
appIdLong业务ID(后台获取,参考 商户接入流程
orderIdString商户订单号(必须保证唯一性,长度不超过48)
amountString交易金额
nameString收款人姓名,(TODO XXX时需要上传)
phoneString真实手机号,(TODO XXX时需要上传)
emailString真实电子邮件,(TODO XXX时需要上传)
subjectString支付备注
bodyString备注详情
inBankNoString公司收款银行卡号
inBankCodeString收款编码
payTypeString用户支付方式
callBackUrlString用户支付成功后跳转地址
callBackFailUrlString用户支付失败后跳转地址
expiryPeriodInteger过期时间
clientTypeString客户端类型
signString签名
outBankNoString付款人银行卡号
outBankCodeString收款编码
countryString信用卡-欧洲收银台-国家编码,可为空
currencyString用户支付币种
userIdLong用户ID,GatePay渠道需要,数字类型
uuidString用户唯一id
goodNameString商品名称
goodsQuantityString商品数量
goodsPriceString商品单价
goodsSkuString商品id
goodsAvatarString商品图片
platformString平台名称
响应
参数名必选类型说明
statusInteger响应码,1表示成功,0表示失败
errorInteger错误码,详情参考 错误码
msgString错误信息
dataorderIdString商户订单号
orderNoString平台订单号
payUrlString收款地址
exchangeRateString汇率,用户支付货币与商户本币不同时返回
orderAmountString订单金额,用户支付货币与商户本币不同时返回
amountString交易金额,用户支付货币与商户本币不同时返回
signString签名
异步通知 当客户代收成功或失败,我方会推送订单状态,每隔5分钟回调一次,持续5次。推送的是客户当次支付信息,金额:本次还款金额,手续费:本次手续费。 URL贵方提供,参考 商户接入流程 请求方式:POST 请求参数
参数名必选类型说明
appIdLong业务ID
currencyString币种
orderIdString商户订单号(必须保证唯一性)
orderNoString平台订单号
amountString本次收款金额
feeString手续费金额
statusInteger订单状态(2收款成功,3:收款失败,4:部分收款,5:超额收款)
payTimeString支付成功时间(当status=2,4,5时有值)(当地时间), 格式: yyyy-MM-dd HH:mm:ss
errorMsgString支付失败原因(当status=3时有值)
signString签名
收到回调通知之后,请返回body(大写)SUCCESS,否则会持续通知5次。

代收查询

查询代收订单 请求参数
参数名必选类型说明
appIdLong业务ID(后台获取,参考 商户接入流程
orderIdString商户订单号
orderNoString平台订单号(响应快)
signString签名
响应
参数名必选类型说明
orderIdString商户订单号(必须保证唯一性,长度不超过48)
orderNoString平台订单号
amountString交易金额
actualAmountString收到金额
feeString手续费
statusInteger状态(0未开始,1收款中,2收款成功3:收款失败,4:部分收款,5:超额收款, -1异常待确认)
payTimeString支付成功时间(当status=2,4,5时有值)(菲律宾时间), 格式: yyyy-MM-dd HH:mm:ss
errorMsgString失败原因(当status=3时有值)
inBankCodeString收款编码
signString签名

退款申请

TODO

代付

代付申请

创建代付订单 URL/{currency}/pay/apply为币种,详情参考 交易支持的国家与币种 请求方式:POST 请求参数:
参数名必选类型说明
appIdLong业务ID(后台获取,参考 商户接入流程
orderIdString商户订单号(必须保证唯一性,长度不超过48)
amountString交易金额
nameString收款人姓名
phoneString真实手机号
emailString真实电子邮件
subjectString支付备注
bodyString备注详情
accountNoString收款人账户
accountTypeString账户类型
bankNameString公司放款银行名称
bankCodeString公司放款银行编号
signString签名
identifyTypeString账号类型-巴西PIX代付
ibanAccountStringiban账号-沙特银行代付,土耳其代付
countryString美国ACH方式需要
address1String美国ACH方式需要
address2String美国ACH方式需要
address3String美国ACH方式需要
postalCodeString美国ACH方式需要
ifscString印度-ifsc
branchNumberString分行编码-土耳其代付
birthString巴基斯坦 出生日期 [yyyy-MM-dd]
genderString巴基斯坦 性别 [MALE, FEMALE or OTHER]
响应

代付查询

账户余额

查询账户

Last modified on April 15, 2026