Documents of USEPAY API

提交支付

请求方式：GET / POST

请求地址：/pub/pay/records/gateway

详细说明：

统一下单接口，所有支付请求均通过此接口向支付平台发起。根据支付方式不同，请求参数和返回数据均有所差异，业务方可根据使用场景不同选用不同的接口。

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文
如currency字段提交了币种，则自动启用货币换算功能，会将您提交的金额换算为通道币种金额再提交支付。（换算汇率以我司每日更新汇率为准，最终提交金额以实际金额为准，请知悉。如需查询我司下单汇率，可使用查询下单汇率接口）
【由于业务策略变更，我司暂未启用换算功能，该字段暂不可用】
时间戳字段我司暂时未进行时间间隔验证，传时间戳是作为备用安全参数，所以不必担心服务器时间等问题导致提交失败。
如果使用的支付通道类型是邮件支付(可在商户中心-我的接口中确认)，则email字段必填，且callfront字段失效，接口将始终认为提交值为-1。

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded
isemailmode	string	否	在使用邮件模式的支付通道时Header中必须传该字段，并且其值为1	1
issmsmode	string	否	在使用短信模式的支付通道时Header中必须传该字段，并且其值为1	1

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
payid	string	是	支付渠道ID	1001
requestid	string	是	商户订单号（由数字、大写英文字母、小写英文字母组成的8~32位字符串）	20180909002
amount	string	是	付款金额（每个通道的币种都可能不同，以【用户中心-我的接口】中所示为准。另外传入金额将被四舍五入精确到小数点后2位。）	23.99
callfront	string	是	正面通知地址（优先以后台设置为准，没设置才以提交时的为准） *可设置或传入-1，则自动使用我司默认友好提示页，商户需要使用回调信息来确认支付
callback	string	是	后台通知地址（优先以后台设置为准，没设置才以提交时的为准）
currency	string	否	您提交的币种（默认认为您的币种与通道币种相同）	USD
timestamp	string	否	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800
customeridentify	string	否	用户标识（可选，可传入用户名、登陆ID、用户ID等，用于某些需要收集信息的通道自动读取该客户最近支付成功的信息）	user123456
customername	string	否	申请支付的客户姓名（可选，某些通道可能会要求必填）	meimei han
idnumber	string	否	申请支付的客户证件号（可选，某些通道可能会要求必填）	012345678
mobile	string	否	申请支付的客户电话（可选，某些通道可能会要求必填）	15000000000
email	string	否	申请支付的客户邮箱（可选，某些通道可能会要求必填）	123456@qq.com
paycard	string	否	申请支付的预设支付卡号（可选，某些通道可能会要求必填）	6223164991230014
customize1	string	否	自定义内容1（可选，回调时会原样发回）	姓名:'韩梅梅1'
customize2	string	否	自定义内容2（可选，回调时会原样发回）	商品:'红大衣2'
customize3	string	否	自定义内容3（可选，回调时会原样发回）	规格:'XXXL3'

实时跳转

请求方式：POST

跳转地址：由商户后台设置或提交支付时指定

详细说明：

客户支付成功或失败后，都将会带着参数跳转到商户指定的地址，商户可以做出入金成功或失败时的提示界面

返回只有一个参数ciphertext
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

返回示例：

        
ciphertext=wwlputO3AfKyi9AqnUm%2FY9c%2FZ8T4S1A%2FJ96k5SR8oCs03%2FuNU%2BlbJltxnqhdPep%2BciYqLcA2CxtD1FC0ChuONB2grI1DCYO181rGtSCibgxGMWjeUJNxyBx9qQFf5GGwORvDEuW%2BAAgEF2GFxVWgAlbARc2k%2BR%2BUXiUhY6YOefPMG5fG3yaysftDvOvGO6xgPix49WS88bOKGENY9sM4snonLoy8eBju5zWPlLXEiPv8n2pVVcgdGTNAKZ5j9yzSzYzMvTXo6js%2Fud3Zs1S5Nt40g6NONl7ifqv0YKFsEfhNMM16dvfxYL2s5%2Ffrw2HCPdgRwELemiI6P8DsjHZREp7ErBkaHaPGjvnubXA%2BKB7e%2FmKIYCtOQGIfP1fzlxdDn2xoNcjUi80qog60x%2BoDBFLx620I0NBox8Mj9VqDRQ2V1kqOrfOxtnjkIEINkO9Y1rUt420TvD6QGq6OaNRxNaSlG3gYmHYNj8yzyf%2BSfzNBKpw6jEM6yNb5O4ua8rX%2B

接收值	描述	类型
ciphertext	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
	{
		"requestid": "1624438261194", 
		"amount": 100, 
		"subamount": 100, 
		"paytime": "2021-06-13 16:51:49", 
		"merchantid": 887082, 
		"orderno": "1624438286359773", 
		"paystatus": 1, 
		"accNo": "622316****0014", 
		"timestamp": 1624438320, 
		"paystatusdesc": "SUCCESS", 
		"customize1": "TEST", 
		"customize2": "TEST", 
		"customize3": "TEST"
	}

ciphertext封装内容	描述	类型
requestid	商户订单号	string
amount	付款金额	string
subamount	提交金额	string
paytime	支付时间	string
merchantid	商户号	string
orderno	支付平台系统订单号	string
paystatus	支付状态（1表示："支付成功"。-1表示："支付失败"。-2表示："实际支付金额与请求的金额不符"。-3表示："支付订单已取消"。-4表示："未知异常"。）	string
paystatusdesc	支付状态描述，字符串类型。其中paystatus为-1或-4时，根据支付通道的不同，可能返回的具体描述有所不同。	string
accNo	客户支付卡号，如无数据会为空字符串	string
timestamp	时间戳（1970年1月1日以来的GMT时间秒数）	string
customize1	自定义内容1（填写了则返回）	string
customize2	自定义内容2（填写了则返回）	string
customize3	自定义内容3（填写了则返回）	string

支付回调

请求方式：POST

回调地址：商户后台设置或提交支付时指定

详细说明：

客户支付成功后，系统会向订单回调地址发送通知，成功接收回调请响应大写的SUCCESS，否则每笔订单系统最多会发送6次回调通知。

返回只有一个参数ciphertext
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

返回示例：

        
ciphertext=wwlputO3AfKyi9AqnUm%2FY9c%2FZ8T4S1A%2FJ96k5SR8oCs03%2FuNU%2BlbJltxnqhdPep%2BciYqLcA2CxtD1FC0ChuONB2grI1DCYO181rGtSCibgxGMWjeUJNxyBx9qQFf5GGwORvDEuW%2BAAgEF2GFxVWgAlbARc2k%2BR%2BUXiUhY6YOefPMG5fG3yaysftDvOvGO6xgPix49WS88bOKGENY9sM4snonLoy8eBju5zWPlLXEiPv8n2pVVcgdGTNAKZ5j9yzSzYzMvTXo6js%2Fud3Zs1S5Nt40g6NONl7ifqv0YKFsEfhNMM16dvfxYL2s5%2Ffrw2HCPdgRwELemiI6P8DsjHZREp7ErBkaHaPGjvnubXA%2BKB7e%2FmKIYCtOQGIfP1fzlxdDn2xoNcjUi80qog60x%2BoDBFLx620I0NBox8Mj9VqDRQ2V1kqOrfOxtnjkIEINkO9Y1rUt420TvD6QGq6OaNRxNaSlG3gYmHYNj8yzyf%2BSfzNBKpw6jEM6yNb5O4ua8rX%2B

接收值	描述	类型
ciphertext	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
	{
		"requestid": "1624438261194", 
		"amount": 100, 
		"subamount": 100, 
		"paytime": "2021-06-13 16:51:49", 
		"merchantid": 887082, 
		"orderno": "1624438286359773", 
		"paystatus": 1, 
		"accNo": "622316****0014", 
		"timestamp": 1624438320, 
		"paystatusdesc": "SUCCESS", 
		"customize1": "TEST", 
		"customize2": "TEST", 
		"customize3": "TEST"
	}

ciphertext封装内容	描述	类型
requestid	商户订单号	string
amount	付款金额	string
subamount	提交金额	string
paytime	支付时间	string
merchantid	商户号	string
orderno	支付平台系统订单号	string
paystatus	支付状态（1表示："支付成功"。-1表示："支付失败"。-2表示："实际支付金额与请求的金额不符"。-3表示："支付订单已取消"。-4表示："未知异常"。）	string
paystatusdesc	支付状态描述，字符串类型。其中paystatus为-1或-4时，根据支付通道的不同，可能返回的具体描述有所不同。	string
setstatus	结算状态（1表示："已结算"。0表示："待结算"。）	string
setcurr	结算币种	string
setamount	结算金额	string
accNo	客户支付卡号，如无数据会为空字符串	string
timestamp	时间戳（1970年1月1日以来的GMT时间秒数）	string
customize1	自定义内容1（填写了则返回）	string
customize2	自定义内容2（填写了则返回）	string
customize3	自定义内容3（填写了则返回）	string

退款

请求方式：GET / POST

请求地址：/pub/pay/records/refund

详细说明：

订单退款接口，商户可使用本接口提交退款请求，将一笔支付成功的订单进行退款。

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文
解密之后orderno和requestid字段不可同时为空，将优先使用orderno查询；requestid必须只能查出一笔唯一的订单，本接口才会工作
cmd字段用于指定待操作的订单状态，例：
传值为0时(Auto)，订单未结算则按未结算模式退款(Void)，订单已结算则按已结算模式退款(Refund)。
传值为1时(Void)，只有目标订单处于尚未结算状态才能被退款；
传值为2时(Refund)，只有目标订单处于已结算状态才能被退款（会在该订单的结算钱包中扣出余额，需要该钱包的余额足够。）；

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
orderno	string	否	系统订单号(用于查询订单)	1622798925426391
requestid	string	否	商户订单号(用于查询订单)	10920180909203400603
amount	string	否	金额（默认为订单全部支付金额，如果该订单已经提交过部分平仓，会提示金额不足）	100
cmd	string	否	操作类型【0自动、1仅结算前、2仅结算后(需钱包余额够扣)】（默认为自动）	0
callback	string	否	回调地址	https://xxxx/callback.jsp
timestamp	string	否	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
    "code": "true",
    "message": "success"
}

接收值	描述	类型
code	返回值，为true时表示成功，为false时表示成功; 为true时代表请求成功，否则为请求失败	string
msg	提示信息，success表示成功，否则具体错误信息	string

退款回调

请求方式：POST

回调地址：商户后台设置或提交代付时指定

详细说明：

退款状态每次更新时，系统会向该笔退款的回调地址发送通知，成功接收回调请响应大写的SUCCESS，否则每笔订单系统最多会发送6次回调通知。

返回只有一个参数ciphertext
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

返回示例：

        
ciphertext=wwlputO3AfKyi9AqnUm%2FY9c%2FZ8T4S1A%2FJ96k5SR8oCs03%2FuNU%2BlbJltxnqhdPep%2BciYqLcA2CxtD1FC0ChuONB2grI1DCYO181rGtSCibgxGMWjeUJNxyBx9qQFf5GGwORvDEuW%2BAAgEF2GFxVWgAlbARc2k%2BR%2BUXiUhY6YOefPMG5fG3yaysftDvOvGO6xgPix49WS88bOKGENY9sM4snonLoy8eBju5zWPlLXEiPv8n2pVVcgdGTNAKZ5j9yzSzYzMvTXo6js%2Fud3Zs1S5Nt40g6NONl7ifqv0YKFsEfhNMM16dvfxYL2s5%2Ffrw2HCPdgRwELemiI6P8DsjHZREp7ErBkaHaPGjvnubXA%2BKB7e%2FmKIYCtOQGIfP1fzlxdDn2xoNcjUi80qog60x%2BoDBFLx620I0NBox8Mj9VqDRQ2V1kqOrfOxtnjkIEINkO9Y1rUt420TvD6QGq6OaNRxNaSlG3gYmHYNj8yzyf%2BSfzNBKpw6jEM6yNb5O4ua8rX%2B

接收值	描述	类型
ciphertext	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
	{
		"requestid": "1640940552189",
		"orderno": "1640940560602434",
		"reforderno": "R1640940560602434B1",
		"currency": "CNY",
		"amount": 50,
		"walletcur": "",
		"walletamt": 0,
		"amountsurplus": 0,
		"cmd": 0,
		"addtime": "2021-12-31 16:49:36",
		"status": 1,
		"audittime": "2021-12-31 16:49:36"
	}

ciphertext封装内容	描述	类型
requestid	商户订单号	string
orderno	系统订单号	string
reforderno	退款订单号	string
currency	收款币种	string
amount	收款金额	string
walletcur	扣款钱包	string
walletamt	扣款金额	string
amountsurplus	剩余可退款金额	string
cmd	操作类型【1:void、2:refund】	string
addtime	提交时间	string
status	审核状态(0:待审核、1:审核通过、-1:审核失败、-2:已取消)	string
audittime	审核时间	string

代付

请求方式：GET / POST

请求地址：/pub/pay/records/payforanother

详细说明：

代付下单接口，商户可使用本接口提交代付请求，代付通常会在1个工作日内审核，1~3个工作日内到账。

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文
商户订单号主要用于唯一性判断和回调。代付商户订单号与支付订单的商户订单号并不冲突，可以相同。
收款币种是CNY时，开户国强制为中国，开户国为选填
收款币种不是CNY时，分行和开户省字段为选填
回调地址优先以商户后台设置为准，如商户后台未设置，则以代付提交时为准，如未指定回调地址，则视为不需要代付回调
开户行bankcode字段可以使用银行代码，请参考[代付银行列表][Json格式]

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
requestid	string	是	商户订单号	1622798925426391
paypass	string	是	支付密码	test1234
walletcur	string	是	扣款钱包	USD
currency	string	是	收款币种	CNY
amount	string	是	收款金额	100
bankcode	string	是	开户行	ICBC
banksub	string	是	分行	北京市朝阳支行
bankname	string	是	户名	张三
bankcard	string	是	卡号	9876543210
bankcountry	string	否	开户国	中国
bankprovince	string	否	开户省	北京市
bankcity	string	否	开户市	北京市
callback	string	否	回调地址	https://xxxx/callback.jsp
timestamp	string	否	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
    "code": "true",
    "message": "success"
}

接收值	描述	类型
code	返回值，为true时表示成功，为false时表示成功; 为true时代表请求成功，否则为请求失败	string
msg	提示信息，success表示成功，否则具体错误信息	string

代付回调

请求方式：POST

回调地址：商户后台设置或提交代付时指定

详细说明：

代付审核通过和转款成功后，系统会分别向该笔代付订单的回调地址发送通知，成功接收回调请响应大写的SUCCESS，否则每笔订单系统最多会发送6次回调通知。

返回只有一个参数ciphertext
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

返回示例：

        
ciphertext=wwlputO3AfKyi9AqnUm%2FY9c%2FZ8T4S1A%2FJ96k5SR8oCs03%2FuNU%2BlbJltxnqhdPep%2BciYqLcA2CxtD1FC0ChuONB2grI1DCYO181rGtSCibgxGMWjeUJNxyBx9qQFf5GGwORvDEuW%2BAAgEF2GFxVWgAlbARc2k%2BR%2BUXiUhY6YOefPMG5fG3yaysftDvOvGO6xgPix49WS88bOKGENY9sM4snonLoy8eBju5zWPlLXEiPv8n2pVVcgdGTNAKZ5j9yzSzYzMvTXo6js%2Fud3Zs1S5Nt40g6NONl7ifqv0YKFsEfhNMM16dvfxYL2s5%2Ffrw2HCPdgRwELemiI6P8DsjHZREp7ErBkaHaPGjvnubXA%2BKB7e%2FmKIYCtOQGIfP1fzlxdDn2xoNcjUi80qog60x%2BoDBFLx620I0NBox8Mj9VqDRQ2V1kqOrfOxtnjkIEINkO9Y1rUt420TvD6QGq6OaNRxNaSlG3gYmHYNj8yzyf%2BSfzNBKpw6jEM6yNb5O4ua8rX%2B

接收值	描述	类型
ciphertext	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
	{
		"requestid": "1639724634951",
		"orderno": "W1639724632326999",
		"walletcur": "USD",
		"currency": "MYR",
		"walletamt": 12.2,
		"amount": 50,
		"rate": 4.099,
		"addtime": "2021-12-17 15:03:52",
		"status": 1,
		"audittime": "2021-12-17 15:25:00",
		"paystatus": 1,
		"wdrtime": "2021-12-17 16:21:25",
		"bankcode": "",
		"banksub": "",
		"bankname": "Customer Name",
		"bankcard": "10000001",
		"bankcountry": "Malaysia",
		"bankprovince": "",
		"bankcity": "Kuala Lumpur"
	}

ciphertext封装内容	描述	类型
requestid	商户订单号	string
orderno	系统订单号	string
walletcur	扣款钱包	string
currency	收款币种	string
walletamt	扣款金额	string
amount	收款金额	string
rate	代付汇率	string
addtime	提交时间	string
status	审核状态(0:待审核、1审核通过、-1审核失败)	string
audittime	审核时间	string
paystatus	转款状态(0:未转款、1:已转款)	string
wdrtime	转款时间	string
bankcode	开户行	string
banksub	分行	string
bankname	户名	string
bankcard	卡号	string
bankcountry	开户国	string
bankprovince	开户省	string
bankcity	开户市	string

查询支付订单

请求方式：GET / POST

请求地址：/pub/pay/records/query

详细说明：

查询支付状态接口，业务应用可通过此接口查询支付订单的状态，以更新业务方的订单支付状态；业务方也可监听支付平台所发送的支付结果通知，更新业务系统的支付状态。

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文
orderno和requestid字段不可同时为空，优先使用orderno查询；
如商户开启允许商户订单号重复，同一个requestid可能查出多个结果，会一并返回所有结果

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
orderno	string	否	系统订单号(用于查询订单)	1622798925426391
requestid	string	否	商户订单号(用于查询订单)	10920180909203400603
timestamp	string	否	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
    "code": "true",
    "message": "success",
    "data": ciphertext,
}

接收值	描述	类型
code	返回值，为true时表示成功，为false时表示成功; 为true时代表请求成功，否则为请求失败	string
msg	提示信息，success表示成功，否则具体错误信息	string
data	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
[
    {
        "requestid": "1624438261194", 
        "amount": 100, 
        "subamount": 100, 
        "paytime": "2021-06-13 16:51:49", 
        "merchantid": 887082, 
        "orderno": "1624438286359773", 
        "paystatus": 1, 
        "accNo": "622316****0014", 
        "amountsurplus": 100, 
        "timestamp": 1624439865, 
        "paystatusdesc": "SUCCESS", 
        "setstatus": 0, 
        "setcurr": "", 
        "setamount": "", 
        "customize1": "TEST", 
        "customize2": "TEST", 
        "customize3": "TEST"
    }
]

ciphertext封装内容	描述	类型
requestid	商户订单号	string
amount	付款金额	string
subamount	提交金额	string
paytime	支付时间	string
merchantid	商户号	string
orderno	支付平台系统订单号	string
paystatus	支付状态（1表示："支付成功"。-1表示："支付失败"。-2表示："实际支付金额与请求的金额不符"。-3表示："支付订单已取消"。-4表示："未知异常"。）	string
paystatusdesc	支付状态描述，字符串类型。其中paystatus为-1或-4时，根据支付通道的不同，可能返回的具体描述有所不同。	string
accNo	客户支付卡号，如无数据会为空字符串	string
amountsurplus	剩余可退款金额	string
setstatus	结算状态（0表示：未结算。1表示：已结算）	string
setcurr	结算币种，未结算则为空	string
setamount	结算金额，未结算则为空	string
timestamp	时间戳（1970年1月1日以来的GMT时间秒数）	string
customize1	自定义内容1（填写了则返回）	string
customize2	自定义内容2（填写了则返回）	string
customize3	自定义内容3（填写了则返回）	string

查询退款订单

请求方式：GET / POST

请求地址：/pub/pay/records/refund/query

详细说明：

查询订单退款状态接口。

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文
orderno、requestid、reforderno三个字段不可同时为空，查询优先级为：reforderno>orderno>requestid；
如商户开启允许商户订单号重复，同一个requestid可能查出多个结果，会一并返回所有结果

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
orderno	string	否	系统订单号(用于查询订单)	1622798925426391
requestid	string	否	商户订单号(用于查询订单)	10920180909203400603
reforderno	string	否	退款订单号(用于查询订单)	R1622798925426391B1
timestamp	string	否	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
    "code": "true",
    "message": "success",
    "data": ciphertext,
}

接收值	描述	类型
code	返回值，为true时表示成功，为false时表示成功; 为true时代表请求成功，否则为请求失败	string
msg	提示信息，success表示成功，否则具体错误信息	string
data	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
[
    {
        "merchantid": 887082, 
        "requestid": "1624438261194", 
        "orderno": "1624438286359773", 
        "reforderno": "R1624438286359773B1", 
        "addtime": "2021-4-14 15:09:44",
        "audittime": "2021-4-14 16:11:19",
        "cmd": 1, 
        "refundamount": 100, 
        "deductamount": 15.53, 
        "refundcurrency": "CNY", 
        "deductcurrency": "USD", 
        "status": 1
    },
    {
        "merchantid": 887082, 
        "requestid": "1624438261194", 
        "orderno": "1624438286359773", 
        "reforderno": "R1624438286359773B2", 
        "addtime": "2021-4-14 15:09:44",
        "audittime": "2021-4-14 16:11:19",
        "cmd": 1, 
        "refundamount": 100, 
        "deductamount": 15.53, 
        "refundcurrency": "CNY", 
        "deductcurrency": "USD", 
        "status": 1
    }
]

ciphertext封装内容	描述	类型
merchantid	商户ID	string
requestid	支付订单商户订单号	string
orderno	支付订单系统订单号	string
reforderno	退款订单号	string
addtime	申请时间	string
audittime	审核时间	string
cmd	操作类型【0:Void、1:Refund、2:Ahead】	string
refundamount	退款金额	string
deductamount	扣款金额	string
refundcurrency	退款币种	string
deductcurrency	扣款币种	string
status【-1:退款失败、0:待审核、1:退款成功】	状态	string

查询代付订单

请求方式：GET / POST

请求地址：/pub/pay/records/payforanother/query

详细说明：

查询代付订单状态接口。

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文
orderno、requestid二个字段不可同时为空，查询优先级为：orderno>requestid；

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
orderno	string	否	系统订单号(用于查询订单)	1623403856822249
requestid	string	否	商户订单号(用于查询订单)	1623403847078
timestamp	string	否	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
    "code": "true",
    "message": "success",
    "data": ciphertext,
}

接收值	描述	类型
code	返回值，为true时表示成功，为false时表示成功; 为true时代表请求成功，否则为请求失败	string
msg	提示信息，success表示成功，否则具体错误信息	string
data	平台用私钥加密的密文	string

        
      商户使用平台提供的公钥对ciphertext解密后得到以下参数:
[
    {
        "merchantid":887082,
        "addtime": "2021-06-13 16:51:49",
        "auditdate": "2021-06-13 16:53:39",
        "orderno": "1623403856822249",
        "requestid": "1623403847078",
        "deductcurrency": "USD",
        "deductamount": 15.35,
        "receivingcurrency": "CNY",
        "receivingamount": 100,
        "feerate": 7.04,
        "status": 1,
        "paystatus": 1,
        "bank": "中国银行",
        "banksub": "上海分行",
        "bankname": "TEST",
        "bankcard": "TEST",
		"bankcountry": "中国",
        "bankprovince": "TEST",
        "bankcity": "TEST",
        "auditexplain": "TEST",
    }
]

ciphertext封装内容	描述	类型
merchantid	商户ID	string
addtime	申请时间	string
audittime	审核时间	string
orderno	代付系统订单号	string
requestid	代付商户订单号	string
deductcurrency	扣款钱包	string
deductamount	扣款金额	string
receivingcurrency	收款币种	string
receivingamount	收款金额	string
feerate	手续费	string
status	状态【0:等待审核、1:审核通过、2:审核未通过】	string
paystatus	转款状态【0:未转款、1:已转款】	string
bank	银行名称	string
banksub	银行分行	string
bankname	账户名称	string
bankcard	收款账户	string
bankcountry	开户国	string
bankprovince	开户省	string
bankcity	开户市	string
auditexplain	原因	string

查询下单汇率

请求方式：GET / POST

请求地址：/pub/pay/records/rate/query

详细说明：

如果下单时使用了可选参数currency，将自动进行币种换算（需开启该功能才能使用，可咨询我司）。本接口是用于查询即将用于币种换算的汇率，以便在您的支付页面提前显示将支付的金额。

返回只有一个参数ciphertext
currency和aimcurrency字段可留空，即为返回所有支持换算的币种，如没有开启换算功能则返回空数组
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

详细说明：

查询我司下单币种换算功能所用的汇率

关键参数为access_token，ciphertext。
access_token：平台提供的商户号
ciphertext：商户将接口指定的参数装入json字符串，再使用平台提供的公钥加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
currency	string	否	原币种	USD
aimcurrency	string	否	目标币种	RM
timestamp	string	是	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
    "code": "true",
    "message": "success",
    "data": {
    	"USDRM":"4.12",
    }
}

接收值	描述	类型
code	返回值，为true时表示成功，为false时表示成功; 为true时代表请求成功，否则为请求失败	string
message	提示信息，success表示成功，否则具体错误信息	string
data	主要数据	string

查询代付汇率

请求方式：GET / POST

请求地址：/pub/pay/payforanother/rate/query

详细说明：

用于获取代付汇率，只能获得当前商户可用于代付的币种对应的汇率，汇率列表可查看[商户中心-申请代付-查看汇率]

返回只有一个参数ciphertext
该接口传入数据均为选填，但即使不传任何字段，传入数据解密之后仍需要是一个合法json字符串。可将字段内容留空，或使用{}
两个币种字段用于筛选，如果没有指定币种，则返回所有可用汇率
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
deductcurrency	string	否	扣款币种	USD
receivingcurrency	string	否	收款币种	RM
timestamp	string	是	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
[{
	"deductcurrency": "USD",
	"receivingcurrency": "CNY",
	"rate": "6.107000"
}, {
	"deductcurrency": "USD",
	"receivingcurrency": "MYR",
	"rate": "4.181325"
}, {
	"deductcurrency": "USD",
	"receivingcurrency": "THB",
	"rate": "33.283150"
}, {
	"deductcurrency": "USD",
	"receivingcurrency": "IDR",
	"rate": "14382.970000"
}, {
	"deductcurrency": "USD",
	"receivingcurrency": "VND",
	"rate": "23728.650000"
}]

接收值	描述	类型
deductcurrency	扣款币种	string
receivingcurrency	收款币种	string
rate	汇率	string

换算代付金额

请求方式：GET / POST

请求地址：/pub/pay/payforanother/amount/conversion

详细说明：

代付接口提交金额的币种是实际收款币种，而不是在您钱包余额中扣款的币种。如果您希望指定在钱包中的扣款金额，使用本接口可以自动为您换算出符合预期的代付金额。

返回只有一个参数ciphertext
ciphertext：平台将预设的参数装入json字符串，再使用平台保存的私钥加密得到的密文

Header参数	类型	必需	描述	示例 e.g.
Content-Type	string	是	建议固定传application/x-www-form-urlencoded	application/x-www-form-urlencoded

Body示例

Query参数	类型	必需	描述	示例 e.g.
access_token	string	是	商户号，分配的商户号	29901
ciphertext	string	是	商户用公钥将JSON加密得到的密文

ciphertext封装内容	类型	必需	描述	示例 e.g.
deductcurrency	string	否	扣款币种	USD
receivingcurrency	string	否	收款币种	CNY
walletamt	string	否	扣款金额	100
timestamp	string	是	时间戳（1970年1月1日以来的GMT时间秒数）	1536131800

返回示例：

        
{
	"deductcurrency": "USDT",
	"receivingcurrency": "CNY",
	"walletamt": "100",
	"feerate": "10.0000",
	"amount": "612.33"
}

接收值	描述	类型
deductcurrency	扣款币种	string
receivingcurrency	收款币种	string
walletamt	扣款金额	string
amount	收款金额(转款金额，可用于提交代付)	string
feerate	手续费	string

RSA加解密接口(GET)

请求方式：GET

请求地址：/tools.php

详细说明：

在线加解密接口，用于在某些语言环境下，不便或无法使用原生源码进行RSA加解密时，可使用该接口代替原生加解密类，进行在线加解密。（例如ASP等，可参考我司ASP Demo）

关键参数为pubkey，cmd、ciphertext(cmd值为2时必填)。
cmd值为1时为加密模式，除了字段pubkey、cmd以外，其他所有字段均视为需加密数据
cmd值为2时为解密模式，将以pubkey为依据，解密ciphertext字段中的密文
本接口为可选辅助接口，建议优先尝试在原生环境下进行RSA加解密。
GET模式由于URL长度和Urlencode标准等原因，使用场景有一定局限性，如非必要建议优先使用POST加解密接口

加密请求示例

        
cmd=1&pubkey=-----BEGIN%20PUBLIC%20KEY-----%5CnMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxZFhu7Yp4T3PS%2Fiech%2FafqyCA%5CnTQhypE2dacgY2wDepP6S1xe1s4RDhrfYl1LnN5VaSrl1w8SXqZkXVl9P3Qj9MAon%5CnhBCH1NdHekLdcKxCcOW9Vjd6HSsTGVxvi5Tjug%2BIh66mtNHkC0ZxcagpgfyarJeQ%5CnhI5So1g1a8C7C6eoqwIDAQAB%5Cn-----END%20PUBLIC%20KEY-----&key1=value1&key2=value2&key3=value3

解密请求示例

        
cmd=2&pubkey=-----BEGIN%20PUBLIC%20KEY-----%5CnMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxZFhu7Yp4T3PS%2Fiech%2FafqyCA%5CnTQhypE2dacgY2wDepP6S1xe1s4RDhrfYl1LnN5VaSrl1w8SXqZkXVl9P3Qj9MAon%5CnhBCH1NdHekLdcKxCcOW9Vjd6HSsTGVxvi5Tjug%2BIh66mtNHkC0ZxcagpgfyarJeQ%5CnhI5So1g1a8C7C6eoqwIDAQAB%5Cn-----END%20PUBLIC%20KEY-----&ciphertext=fcoJYQ%2BVG3xs9fTrvSGwkSlfjL8yTkTLN695bT96Y646PR%5C%2F2rADftdkyB0j3%5C%2FhbNjAljwv2P%5C%2FvJlunfu8KZBNYYxm1tTr9O75vy3GOI3vDT%2BWzzrf0ZJ8b9%5C%2FcxoRrIZ%5C%2FcBaRqCcx%2Batzcrjjy32x0kkxP0JicMWJwN1vSCKMnB0%3D

接收值	描述	类型
pubkey	商户公钥(需要进行UrlEncode处理)	string
cmd	操作类型，可选值[1,2]。1.加密；2.解密	number
key=value	cmd=1时：要加密的数据，除pubkey、cmd以外其他所有字段均视为需加密数据，遵循POST传参规则	string
ciphertext	cmd=2时：需解密的密文，当操作类型为解密时必填。(需要进行UrlEncode处理)	string

RSA加解密接口(POST)

请求方式：POST

请求地址：/tools/encryption

详细说明：

在线加解密接口，用于在某些语言环境下，不便或无法使用原生源码进行RSA加解密时，可使用该接口代替原生加解密类，进行在线加解密。（例如ASP等，可参考我司ASP Demo）

关键参数为pubkey、cmd
cmd值为1时为加密模式，plaintext字段必填，传入需加密的json或其他字符串
cmd值为2时为解密模式，ciphertext字段必填，传入需解密的密文
本接口为可选辅助接口，建议优先尝试在原生环境下进行RSA加解密

加密请求示例

        
cmd=1&pubkey=LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlHZk1BMEdDU3FHU0liM0RRRUJBUVVBQTRHTkFEQ0JpUUtCZ1FDKzJ5UVZQQ0RzT0Exa3ViTjIwWXVLNTlWVgpNT0pQOGpWcXNBMEY4ZUFkb3NnTHQvWVFDRGRXdWlLMERMRytxanoyd2dVVFdNMDM5MVRSWGhkVVBGcUNHaFY5CjBpamJaOWEwQmJJMmZHWHNrMXpEall2TlRBeUg0Ui9ibWc0ejFucEE3UWJacEl2NjNFNFcvMUpyOW8xT2VQQTMKTVViRkQwcDJudVBMRXE5RW9RSURBUUFCCi0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==&plaintext=dGVzdA==

解密请求示例

        
cmd=2&pubkey=LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlHZk1BMEdDU3FHU0liM0RRRUJBUVVBQTRHTkFEQ0JpUUtCZ1FDKzJ5UVZQQ0RzT0Exa3ViTjIwWXVLNTlWVgpNT0pQOGpWcXNBMEY4ZUFkb3NnTHQvWVFDRGRXdWlLMERMRytxanoyd2dVVFdNMDM5MVRSWGhkVVBGcUNHaFY5CjBpamJaOWEwQmJJMmZHWHNrMXpEall2TlRBeUg0Ui9ibWc0ejFucEE3UWJacEl2NjNFNFcvMUpyOW8xT2VQQTMKTVViRkQwcDJudVBMRXE5RW9RSURBUUFCCi0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==&ciphertext=TjV3SkpZVDR3STlXcEQ5UzhuVG1pdkxwaHVwbU9uM21Tb0p5S3BWeEdtY3FuaGlKV2hLOHhYbHp2VktOQzJLZTVIbXdCRDZaQjYzK0JUYTZUNzlrQlIwb0ZlWThNNGJxM2poRHB5U3VrQ2hnMGVuNitxc0lwNGtqS0ptckNnYXlhTnUyMVoxdXl2R1ZKYlREU3dRbVVwbnRqdWVCTVFZSVBQcTh0czNneDVRPQ==

接收值	描述	类型
pubkey	商户公钥(需要进行Base64编码)	string
cmd	操作类型，可选值[1,2]。1.加密；2.解密	number
plaintext	cmd=1时：要加密的明文，cmd为1时必填(需要进行Base64编码)	string
ciphertext	cmd=2时：需解密的密文，cmd为2时必填(需要进行Base64编码)	string

Gateway

提交支付

实时跳转

支付回调

退款

退款回调

代付

代付回调

查询支付订单

查询退款订单

查询代付订单

查询下单汇率

查询代付汇率

换算代付金额

RSA加解密接口(GET)

RSA加解密接口(POST)