支付/预授权

API

跳转式收银台

POST BASE_URL/cashier

Headers

Name

Type

Description

Content-Type*

String

application/x-www-form-urlencoded

Request Body

Name

Type

Description

sign*

string

签名值

signType*

string

签名类型 MD5 / RSA (4)

echoParam

string

回声参数，Response 中将会原样返回 (256)

notifyUrl

string

异步通知地址 (512)

userInfo*

string

payerInfo*

string

currency*

string

orderInfo*

string

amount*

string

appId*

string

提交审核的网站, 需与商户后台网站审核值一致 (128)

transactionExpirationTime*

integer

交易过期时间(单位为分钟) (6)

transactionType*

string

传 pay / authorization (18)

transactionId*

string

订单号, 需要唯一 (64)

merchantNo*

string

商户号 (16)

autoRedirect

boolean

true/ false 默认 true

version*

string(5)

目前固定为 1.0 (5)

redirectUrl

String

重定向请求的跳转地址 max=512

terminalType*

String(8)

终端类型 WEB/H5

{
    "amount": "123",
    "redirectUrl": "https://checkout1.uat.useepay.com/?accessToken=eAF1VW1r20Yc_yrj-tZOJNlxJb9L03orJK1Z0pVRl3HWne1bJZ16OsUVnqF907UsIR1bxmAMSt90MOgeYGxsHf0uo46zV_sK-_9POlfpg0Ns3e93_-cHzYjiWR5p0p2RkVCZvkJjTrpkKKJIJOPeCmqQiL7OblukQUKq2F6R8ox0b5BPwyFpkBhYrpCAA03TiKe0wEcOX_CY0gge9kVGyc0GGVPNp7TYlbkK0YFru5cu9Tc_Lq_GPNE7XE8kQ_2zM9ZmRINdkAC988bqhD7UjjVnaqgxPgfrSRl1qDgT-hPjM16rR7XSXLleE7PIuyRWwddkzmBSMa4uJyOJZahSf5FnoRKplgpiuw21mOT0vRFNICPglhIgwICZTqdrYH8tlDEyuVI8CQuTwIsAjCXkrNRMbswG5HZOEy10MSBdtzEgqRIhh-cBcb21VntAAMNcGGhxfH_x1b3Fo8Pl058NI1gNXz7_ZnH0u8FDqN1YqmJP8brk8pe_lt89O3n85X_PD17-cbh4dLD88-niwY8l_vLvF8uvf_jn7vefwf_iwf3Fw1-NsqFk6N2AlOZPjo5OX5TmrZkaW6oyctmtvEaYEwQzVDSpew0BLR8eGIFcRTUBc5rftCmrxuD02ZPF4fHJ48__ffItUDH08wQSeNXUC9PvOZ7rOu6G0_ZaTrsFd8paIgd4Sbodr9XZcPygA7wGj7LNGCYOct6CHiU0irZkMhJj2wGU0RRGB244bZAYSq1lfB0UA7JZ-wAX0iTk0Ydc5yq5piK4gA0xpILltiXA4THfhq-cjnFOXBRTnJadRVkskk2AeDzkjHHWi8ZoGJGE7YmYb8nI9OC5Xq_ddpAYx3oLFXCkoZE6nue4jtdun_cDw-5IJkaFZVuuvxG4QQd-GkRAEIHTgodsdyKnWzJPNJPTpLIZvfKTY6vHVCR7MkG_zznw6fUQRF_L9ncRdBy33cHc2_qYydgoKfw-3_IxaktXxe2d_PbF6U_HSKC_MFFgZZUPGKoL-k3bCOdQj6Qv7nDItwe7DBIF89mXUYQhw4qCOGGy9mlYACjC4u2VwWWjeKghW7YuGaTkAqzeKhv2CNrPrAMMxnD1zrDgFmzciYxYtdNW8P4-aLWnnpRlh1ngfVwUDHZO7ZLBXlOzLcewpUx_oAdmErCmK83X-TATehWQpkqf6aL2Jv5hAEVyRWrIO8y1kEm53yvVmsdpBA2GhfSgWey5qtwHEl4trE8LfDH0sa1fXSlzvW4QFWdXRzBbsNTBwturYOYRPZQ5zqTn-9jiWhXbMoQ3VBlqnvGdavZ3y-AcMofRtSUsVU-0TrPu-nr1LtM802sgie89HEaLN5FYt6IfeTkatL35jtY1rwsI2HpxmUHktmetLBpZy2DhDeUdaxhjkbdglrrQ5Wk3pqnooums6_mBM_I7TtNjgdt0XR42Ay9gTdrxNjqB4_mtwCfz_wEXGNID",
    "resultCode": "received",
    "sign": "c60982754906a3f326ff672108e55ca1",
    "errorCode": "0000",
    "transactionId": "202110150423043",
    "errorMsg": "Approved or completed successfully",
    "token": "mop:mapi:redis:2890f860-2d91-11ec-929d-a62569028398",
    "transactionType": "pay",
    "reference": "1012110151623650896",
    "echoParam": "echoParam",
    "reserved": "reserved",
    "signType": "MD5",
    "currency": "USD",
    "merchantNo": "500000000007381"
}

会自动重定向，也可以在response header中的location获取

Response Header

Location: https://checkout1.uat.useepay.com/?accessToken=eAF1VV1v21QY_ivo7DZtbSdNk9x13QKT2q2iHRNaJnTic5KY2T7e8XEzq1SCm7GJVh2CIiSENO1mSEjjQ0IgGNp_QUtTrvgLPO-xnbn7SNXE53nO-_3hfaZlmoWG9fbZKNCpucojyXpsGIRhEI_7C6jBQv4qu1khDeZzLXbzRKasd5N97A9Zg0VgpSYCB54koUx4To8SX3hMeIiHvSDl7FaDjbmRU57vqEz75MD1ncuXt9c_LK5GMjZb0kyUIP3756ztMwO7kIDeg8biRD7UjjVnaqg1fgDrcRG1r6UIzEfWZ7pWj2qhuXS9JlYhb5NYBF-TOYcpLaS-Eo8UlaFM_SWZ-jpIjNKI7Q5qMcn4OyMeIyNwSwcQEGCm0-ky7C_7KiIm01rGfm4TeAnAWCFnhWZ2c3_A7mQ8NoHJB6znNgYs0YEv8TxgrrfcbA0YMMqFhWYn92ZffTZ7eDR_8rNlAlHD58--mR3_bnEftRsrne9qWZec__LX_Lunp4--O_Z4Ys_jmYPD-d_Ppnd_7HAX_z9fP71D_98-v0n-J_dvzd78KtVNlSCvBuwwvzp8fHZ88J8ZabGFqqsXHo7qxH2hGCGmsd1rxHQ_MGhFch0WBOwp4NbVcrKMTh7-nh2dHL66PN_H38LKkI_T5DAa7ZelH7P8VzXcVedlrfmrTm4U9SSOOAF6ba9tfaq0-l2wBt4lK5HmDjkvIkeZTwMN1Q8CsZVB3DBE4wObjgtSAyVMSq6AcVA1msfcD6PfRm-L02m4-s6xAVqiCEPRFa1BBwey018ZXxMc-KSmJa86CwuoiBeBySjoRRCin44JsOExGI3iOSGCm0PXuj3Wy2HiHFkNkiBJBqN1PY8x3W8Vmut07XslhLBKK_YpttZ7brdNn4aLEAQXaeJh3RnoqYbKouNUNO4tBm-9FNSq0c8iHdVTH5fcPDp9wkkX4v2dwl0HLfVblqiqI-djNWCou-1ZoeirspXFrd-tsXZz-dEEH-YqJgZZEPDNVF87ptgjPUI94O7krk28MuQ6Iwn9sqDClkrCjEicna434OMPDzN1eGlo2WvkG2qrqkSMlFrN4yG9UR2s-tAwrGcvXOqMANbNyJCkW50xbw3h60Vqe-UkWHVcC7tCgEdk7tksVeUbOpxthStj_IAzsJVNOF5htymAZmEZDh2pzrotY6_VEAeXxVGeQdcx2ouNjvpWojoyREg1EhPTRLdS4r957Cq0Vs85xeDNvU1i-vFLlesYiO0msjzBaWOiy8uQp2HslDldFMep0OtbjR-aby8YYqQs1SuVXO_k4RnMMOMLpVCQvVE2OStLeyUr7LjEzNMiTpvUfDWOFLRKxUoh94GRmsevMtrWtfFwi48uKKQORVz1ayZGQ5xcIbqruVYYpF3cYs9dDlSS_iSdAj02nPX21jKofOkie67pLrSn-p63XFEm97YByv08S-OvgfVqTSOw%3D%3D

Pay Result

{
    "amount": "1234",
    "currency": "USD",
    "echoParam": "echoParam",
    "errorCode": "0000",
    "errorMsg": "Approved or completed successfully",
    "merchantNo": "500000000007381",
    "reference": "1012112011024652513",
    "referer": "https://gatewaytest.useepay.com/",
    "resultCode": "succeed",
    "sign": "1aab1771d7846efb74edb801a0fd772d",
    "signType": "MD5",
    "transactionId": "202112011024047",
    "transactionType": "pay",
    "version": "1.0"
}

{
    "amount": "1234",
    "currency": "USD",
    "echoParam": "echoParam",
    "errorCode": "0000",
    "errorMsg": "Approved or completed successfully",
    "merchantNo": "500000000007381",
    "reference": "1102112011016652511",
    "referer": "https://gatewaytest.useepay.com/",
    "resultCode": "succeed",
    "sign": "37fd3957f5f96cfe91550128d716038c",
    "signType": "MD5",
    "transactionId": "202112011016327",
    "transactionType": "authorization",
    "version": "1.0"
}

字段

长度

描述

是否必要

merchantNo

max=16

max=16 商户编号，由 USEEPAY 分配

yes

transactionId

max=64

商户订单号，需保证在商户端不重复

yes

transactionType

max=18

交易类型：pay/authorization

yes

reference

max=32

USEEPAY 订单号

amount

max=12

yes

currency

max=3

yes

resultCode

max=32

yes

errorCode

max=4

错误码（详见错误码 errorCode）

errorMsg

max=256

错误码消息描述

echoParam

max=256

回声参数，响应报文会原样返回

sign

max=256

签名

yes

Previous收银台 Next内嵌式收银台

Last updated 2 years ago

跳转式收银台

POST BASE_URL/cashier

Headers

Name

Type

Description

Content-Type*

String

application/x-www-form-urlencoded

Request Body

Name

Type

Description

sign*

string

签名值

signType*

string

签名类型 MD5 / RSA (4)

echoParam

string

回声参数，Response 中将会原样返回 (256)

notifyUrl

string

异步通知地址 (512)

userInfo*

string

json string, 消费者信息, 请参考

payerInfo*

string

json string, 付款方信息, 请参考

currency*

string

货币单位，请参考一节

orderInfo*

string

json string, 订单信息, 请参考

amount*

string

订单金额, 必须大于0，单位为对应货币的最小货币单位参考节 (12)

appId*

string

提交审核的网站, 需与商户后台网站审核值一致 (128)

transactionExpirationTime*

integer

交易过期时间(单位为分钟) (6)

transactionType*

string

传 pay / authorization (18)

transactionId*

string

订单号, 需要唯一 (64)

merchantNo*

string

商户号 (16)

autoRedirect

boolean

true/ false 默认 true

version*

string(5)

目前固定为 1.0 (5)

redirectUrl

String

重定向请求的跳转地址 max=512

terminalType*

String(8)

终端类型 WEB/H5

{
    "amount": "123",
    "redirectUrl": "https://checkout1.uat.useepay.com/?accessToken=eAF1VW1r20Yc_yrj-tZOJNlxJb9L03orJK1Z0pVRl3HWne1bJZ16OsUVnqF907UsIR1bxmAMSt90MOgeYGxsHf0uo46zV_sK-_9POlfpg0Ns3e93_-cHzYjiWR5p0p2RkVCZvkJjTrpkKKJIJOPeCmqQiL7OblukQUKq2F6R8ox0b5BPwyFpkBhYrpCAA03TiKe0wEcOX_CY0gge9kVGyc0GGVPNp7TYlbkK0YFru5cu9Tc_Lq_GPNE7XE8kQ_2zM9ZmRINdkAC988bqhD7UjjVnaqgxPgfrSRl1qDgT-hPjM16rR7XSXLleE7PIuyRWwddkzmBSMa4uJyOJZahSf5FnoRKplgpiuw21mOT0vRFNICPglhIgwICZTqdrYH8tlDEyuVI8CQuTwIsAjCXkrNRMbswG5HZOEy10MSBdtzEgqRIhh-cBcb21VntAAMNcGGhxfH_x1b3Fo8Pl058NI1gNXz7_ZnH0u8FDqN1YqmJP8brk8pe_lt89O3n85X_PD17-cbh4dLD88-niwY8l_vLvF8uvf_jn7vefwf_iwf3Fw1-NsqFk6N2AlOZPjo5OX5TmrZkaW6oyctmtvEaYEwQzVDSpew0BLR8eGIFcRTUBc5rftCmrxuD02ZPF4fHJ48__ffItUDH08wQSeNXUC9PvOZ7rOu6G0_ZaTrsFd8paIgd4Sbodr9XZcPygA7wGj7LNGCYOct6CHiU0irZkMhJj2wGU0RRGB244bZAYSq1lfB0UA7JZ-wAX0iTk0Ydc5yq5piK4gA0xpILltiXA4THfhq-cjnFOXBRTnJadRVkskk2AeDzkjHHWi8ZoGJGE7YmYb8nI9OC5Xq_ddpAYx3oLFXCkoZE6nue4jtdun_cDw-5IJkaFZVuuvxG4QQd-GkRAEIHTgodsdyKnWzJPNJPTpLIZvfKTY6vHVCR7MkG_zznw6fUQRF_L9ncRdBy33cHc2_qYydgoKfw-3_IxaktXxe2d_PbF6U_HSKC_MFFgZZUPGKoL-k3bCOdQj6Qv7nDItwe7DBIF89mXUYQhw4qCOGGy9mlYACjC4u2VwWWjeKghW7YuGaTkAqzeKhv2CNrPrAMMxnD1zrDgFmzciYxYtdNW8P4-aLWnnpRlh1ngfVwUDHZO7ZLBXlOzLcewpUx_oAdmErCmK83X-TATehWQpkqf6aL2Jv5hAEVyRWrIO8y1kEm53yvVmsdpBA2GhfSgWey5qtwHEl4trE8LfDH0sa1fXSlzvW4QFWdXRzBbsNTBwturYOYRPZQ5zqTn-9jiWhXbMoQ3VBlqnvGdavZ3y-AcMofRtSUsVU-0TrPu-nr1LtM802sgie89HEaLN5FYt6IfeTkatL35jtY1rwsI2HpxmUHktmetLBpZy2DhDeUdaxhjkbdglrrQ5Wk3pqnooums6_mBM_I7TtNjgdt0XR42Ay9gTdrxNjqB4_mtwCfz_wEXGNID",
    "resultCode": "received",
    "sign": "c60982754906a3f326ff672108e55ca1",
    "errorCode": "0000",
    "transactionId": "202110150423043",
    "errorMsg": "Approved or completed successfully",
    "token": "mop:mapi:redis:2890f860-2d91-11ec-929d-a62569028398",
    "transactionType": "pay",
    "reference": "1012110151623650896",
    "echoParam": "echoParam",
    "reserved": "reserved",
    "signType": "MD5",
    "currency": "USD",
    "merchantNo": "500000000007381"
}

会自动重定向，也可以在response header中的location获取

Response Header

Location: https://checkout1.uat.useepay.com/?accessToken=eAF1VV1v21QY_ivo7DZtbSdNk9x13QKT2q2iHRNaJnTic5KY2T7e8XEzq1SCm7GJVh2CIiSENO1mSEjjQ0IgGNp_QUtTrvgLPO-xnbn7SNXE53nO-_3hfaZlmoWG9fbZKNCpucojyXpsGIRhEI_7C6jBQv4qu1khDeZzLXbzRKasd5N97A9Zg0VgpSYCB54koUx4To8SX3hMeIiHvSDl7FaDjbmRU57vqEz75MD1ncuXt9c_LK5GMjZb0kyUIP3756ztMwO7kIDeg8biRD7UjjVnaqg1fgDrcRG1r6UIzEfWZ7pWj2qhuXS9JlYhb5NYBF-TOYcpLaS-Eo8UlaFM_SWZ-jpIjNKI7Q5qMcn4OyMeIyNwSwcQEGCm0-ky7C_7KiIm01rGfm4TeAnAWCFnhWZ2c3_A7mQ8NoHJB6znNgYs0YEv8TxgrrfcbA0YMMqFhWYn92ZffTZ7eDR_8rNlAlHD58--mR3_bnEftRsrne9qWZec__LX_Lunp4--O_Z4Ys_jmYPD-d_Ppnd_7HAX_z9fP71D_98-v0n-J_dvzd78KtVNlSCvBuwwvzp8fHZ88J8ZabGFqqsXHo7qxH2hGCGmsd1rxHQ_MGhFch0WBOwp4NbVcrKMTh7-nh2dHL66PN_H38LKkI_T5DAa7ZelH7P8VzXcVedlrfmrTm4U9SSOOAF6ba9tfaq0-l2wBt4lK5HmDjkvIkeZTwMN1Q8CsZVB3DBE4wObjgtSAyVMSq6AcVA1msfcD6PfRm-L02m4-s6xAVqiCEPRFa1BBwey018ZXxMc-KSmJa86CwuoiBeBySjoRRCin44JsOExGI3iOSGCm0PXuj3Wy2HiHFkNkiBJBqN1PY8x3W8Vmut07XslhLBKK_YpttZ7brdNn4aLEAQXaeJh3RnoqYbKouNUNO4tBm-9FNSq0c8iHdVTH5fcPDp9wkkX4v2dwl0HLfVblqiqI-djNWCou-1ZoeirspXFrd-tsXZz-dEEH-YqJgZZEPDNVF87ptgjPUI94O7krk28MuQ6Iwn9sqDClkrCjEicna434OMPDzN1eGlo2WvkG2qrqkSMlFrN4yG9UR2s-tAwrGcvXOqMANbNyJCkW50xbw3h60Vqe-UkWHVcC7tCgEdk7tksVeUbOpxthStj_IAzsJVNOF5htymAZmEZDh2pzrotY6_VEAeXxVGeQdcx2ouNjvpWojoyREg1EhPTRLdS4r957Cq0Vs85xeDNvU1i-vFLlesYiO0msjzBaWOiy8uQp2HslDldFMep0OtbjR-aby8YYqQs1SuVXO_k4RnMMOMLpVCQvVE2OStLeyUr7LjEzNMiTpvUfDWOFLRKxUoh94GRmsevMtrWtfFwi48uKKQORVz1ayZGQ5xcIbqruVYYpF3cYs9dDlSS_iSdAj02nPX21jKofOkie67pLrSn-p63XFEm97YByv08S-OvgfVqTSOw%3D%3D

Pay Result

{
    "amount": "1234",
    "currency": "USD",
    "echoParam": "echoParam",
    "errorCode": "0000",
    "errorMsg": "Approved or completed successfully",
    "merchantNo": "500000000007381",
    "reference": "1012112011024652513",
    "referer": "https://gatewaytest.useepay.com/",
    "resultCode": "succeed",
    "sign": "1aab1771d7846efb74edb801a0fd772d",
    "signType": "MD5",
    "transactionId": "202112011024047",
    "transactionType": "pay",
    "version": "1.0"
}

{
    "amount": "1234",
    "currency": "USD",
    "echoParam": "echoParam",
    "errorCode": "0000",
    "errorMsg": "Approved or completed successfully",
    "merchantNo": "500000000007381",
    "reference": "1102112011016652511",
    "referer": "https://gatewaytest.useepay.com/",
    "resultCode": "succeed",
    "sign": "37fd3957f5f96cfe91550128d716038c",
    "signType": "MD5",
    "transactionId": "202112011016327",
    "transactionType": "authorization",
    "version": "1.0"
}

字段

长度

描述

是否必要

merchantNo

max=16

max=16 商户编号，由 USEEPAY 分配

yes

transactionId

max=64

商户订单号，需保证在商户端不重复

yes

transactionType

max=18

交易类型：pay/authorization

yes

reference

max=32

USEEPAY 订单号

amount

max=12

支付金额，单位为对应币种的最小货币单位

yes

currency

max=3

3 位 ISO 大写字母货币代码

yes

resultCode

max=32

业务结果（详见）判断交易是否成功的依据

yes

errorCode

max=4

错误码（详见错误码 errorCode）

errorMsg

max=256

错误码消息描述

echoParam

max=256

回声参数，响应报文会原样返回

sign

max=256

签名

yes