USEEPAY
  1. 订单通用接口
USEEPAY
  • 全球收单
    • 域名说明
    • 集成流程说明
    • 生产账户启用
    • UseePay出口IP说明
    • 签名指导
      • 签名
      • 验签
      • demo
    • 沙盒测试资源
      • 测试卡号
      • 信用卡测试案例
      • 退款测试案例
      • 本地化测试案例
      • ApplePay&& Google Pay测试用例
    • 跳转式收银台接口
      • 跳转收银台paymentMethod参数说明
      • 支付/预授权
    • 内嵌式收银台接口
      • 0.0.1-只支持信用卡
        • 内嵌收银台快捷支付
        • 内嵌收银台新版本更新说明
        • 内嵌收银台对接说明
      • 新版-支持信用卡+AP+GP
        • 内嵌收银台2.0.0版本说明
      • create token 创建JSSDK所需的token
    • 订单通用接口
      • 退款Refund
        POST
      • 查询Query
        POST
      • 预授权撤销(Void)
        POST
      • 预授权完成(Capture)
        POST
    • 本地化支付
      • 本地化汇总
      • 本地化接口
        • 便利店支付
          • konbini
            • konbini 收银台模式
            • konbini api模式
          • payeasy
            • payeasy api 模式
            • payeasy 收银台模式
        • 分期付款Pay Later
          • Klarna产品介绍
          • Klarna direct
          • Klarna Redirect
        • 电子钱包
          • Alipay
            • Alipay Direct 文档
            • alipay_cn/alipay_hk direct 文档
          • Wechat-HK
            • 扫码支付
              • 扫码支付
              • direct
                • 扫码支付 Server To Server模式
              • redirect
                • 扫码支付收银台模式(wechat_native)
            • Jsapi支付下单接口
              • 小程序支付
              • 微信公众号支付
              • Jsapi支付下单接口
            • H5支付
              • H5支付
          • Google Pay
            • GoogePay Test card
            • Google Pay 对接可能遇到的问题
            • redirect
              • 跳转式GooglePay收银台
            • api
              • Google Pay API对接
              • Googlepay API 支付
          • applepay
            • ApplePay 扩展
            • ApplePay API
              • ApplePay API接入流程
              • ApplePay API接入流程备份
              • ApplePay Merchant Identifier
              • ApplePay支付
              • ApplePay商户Session
            • applepay cashier
              • applepay 跳转收银台
          • applepay&googlepay内嵌
            • 1.0.0 内嵌方式对接 (建议使用“内嵌方式对接2.0.0”版本)
            • 内嵌方式对接2.0.0
        • 银行转账
          • pix
          • Giropay
            • Giropay_Redirect
            • Giropay_Direct
          • sofort
            • sofort_Redirect
            • sofort_Direct
          • bancontact
            • bancontact_Redirect
          • Ideal
            • Ideal_Redirect
            • Ideal_Direct
          • boleto
            • boleto_Direct
        • 本地化Card
        • Cash(Ticket)现金支付
          • oxxo
          • boleto
          • Cash Common
      • 支付方式(国家/地区)
        • 荷兰
        • 巴西
        • 墨西哥
        • 中国香港
        • 日本
        • 德国
        • 奥地利
        • 西班牙
        • 波兰
        • 意大利
        • 哥伦比亚
        • 比利时
        • 瑞士
    • 通用对象参数和规范说明
      • 参数对象说明(过期)
      • 业务结果码(ResultCode)
      • 错误码(ErrorCode)
      • 金额和货币单位
      • 国家信息参考
      • 对象模型
        • userInfo
        • shippingAddress
        • goodsInfo
        • billingAddress
        • deviceInfo
        • transactionInfo
    • 通知接口说明
      • 交易通知
        • 同步通知
        • 异步 webhook版本升级
        • webhook
      • 拒付
        • 拒付webhook
    • 物流接口
      • 物流信息上送
        • 物流信息上传2.1
        • 物流信息上传(已废弃)
      • 物流信息查询
        • 物流信息查询2.1
        • 物流信息查询(已废弃)
    • 拒付接口
      • 拒付流程说明
      • 拒付查询
    • SFTP
      • SFTP
    • 常见问题
      • 支付和预授权的区别
    • demo
    • 插件安装指导
      • magento插件支付安装
        • Wechat/Alipay/UseePay Payments
    • 订阅
      • 订阅文档
  • 产品说明
    • 收银台
    • 内嵌式收银台
    • Server To Server 直连
  • FAQ
    • 集成和认证
    • 常见问题解答
    • ueeshop配置常见错误
    • ApplePay常见问题
  1. 订单通用接口

查询Query

全球收单-SandBox环境
https://pay-gateway1.uat.useepay.com
全球收单-SandBox环境
https://pay-gateway1.uat.useepay.com
POST
/api

功能描述#

当出现交互超时、异常时,可通过订单查询接口查询预授权、预授权完成、支付、预授权撤销、退款交易。

时序图#

Response 参数对象说明#

参数说明是否必须
merchantNomax=16 商户编号,由 USEEPAY 分配true
resultCodemax=32本次查询的业务结果(详见 业务结果码)true
errorCodemax=4本次查询的错误码false
errorMsgmax=256本次查询的错误码消息描述false
transactionInfo交易信息。resultCode=xxxx 的时候有返回
reservedmax=256预留字段,值同请求报文false
echoParammax=256 回声参数,响应报文会原样返回false
signmax=256商户请求参数的签名串true

transactionInfo 参数对象说明#

参数描述是否必须
transactionIdmax=64商户订单号true
originalTransactionIdmax=64 原始商户订单号
referencemax=32USEEPAY 订单号false
transactionTypemax=64 pay; authorization; refund; capture;authorizationVoid;true
amountmax=12交易金额,单位为对应币种的最小货币单位(详见 ISO 4217)false
currencymax=33 位 ISO 大写字母货币代码(详见 ISO 4217)false
arnmax=128 ARNfalse
settlementList集合 支付成功的订单的结算信息false
resultCodemax=32业务结果(详见 业务结果码)true
errorCodemax=4错误码(详见 错误码 errorCode)false
errorMsgmax=256错误码消息描述false

settlement 参数对象说明#

参数描述是否必须
settlementCurrencymax=3 结算币种false
settlementRatemax=12 结算汇率false
settlementCurrencymax=12 结算金额false

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/x-www-form-urlencoded
Body 参数application/x-www-form-urlencoded
version
string 
必需
max=5 调用的接口版本,固定为:1.0
示例值:
1.0
merchantNo
string 
必需
max=16 商户号,由USEEPAY分配
示例值:
500000000007362
transactionId
string 
可选
max=64 商户订单号。transactionld 和reference二选—
示例值:
202301300237522
transactionType
string 
必需
max=18 交易类型:query
示例值:
query
reference
string 
可选
string max=32USEEPAY订单号
示例值:
202301300237522
notifyUrl
string 
可选
max=512 USEEPAY回调商户地址
示例值:
https://gatewaytest.useepay.com/gateway-test/redirectV2u0
signType
string 
必需
max=4 商户生成签名字符串所使用的签名算法类型,目前支持:RSA MD5
示例值:
MD5
sign
string 
必需
max=256商户请求参数的签名串
示例值:
decb3b9b728c7af4251acae23804939b
echoParam
string 
可选
max=256 回声参数,响应报文会原样返回
示例值:
echoParam

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://pay-gateway1.uat.useepay.com/api' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'version=1.0' \
--data-urlencode 'merchantNo=500000000007362' \
--data-urlencode 'transactionId=202301300237522' \
--data-urlencode 'transactionType=query' \
--data-urlencode 'reference=202301300237522' \
--data-urlencode 'notifyUrl=https://gatewaytest.useepay.com/gateway-test/redirectV2u0' \
--data-urlencode 'signType=MD5' \
--data-urlencode 'sign=decb3b9b728c7af4251acae23804939b' \
--data-urlencode 'echoParam=echoParam'

返回响应

🟢200成功
application/json
Body
echoParam
string 
可选
max=256 回声参数,响应报文会原样返回
resultCode
string 
必需
max=32 表示本次查询的结果(详见 业务结果码)
sign
string 
必需
errorCode
string 
可选
错误码(详见 错误码 errorCode)
signType
string 
必需
max=16 商户生成签名字符串所使用的签名算法类型 RSA/MD5
merchantNo
string 
必需
max=16 商户编号,由 USEEPAY 分配
errorMsg
string 
本次查询的错误码消息描述
可选
错误码(详见 错误码 errorMsg)
transactionInfo
string 
必需
交易订单的信息
示例
{
  "echoParam": "echoParam",
  "resultCode": "succeed",
  "sign": "26e12b8a690f9d4584d19272359a5520",
  "signType": "MD5",
  "errorCode": "0000",
  "merchantNo": "500000000008901",
  "errorMsg": "Successful payment",
  "transactionInfo": "{\"transactionType\":\"pay\",\"reference\":\"1012404081006710607\",\"amount\":\"1111\",\"originalTransactionId\":\"\",\"resultCode\":\"succeed\",\"errorCode\":\"0000\",\"currency\":\"USD\",\"arn\":\"6612404081006710607\",\"transactionId\":\"202404081006163\",\"settlement\":[{\"settlementCurrency\":\"USD\",\"settlementRate\":\"1\",\"settlementAmount\":\"11.11\"}],\"errorMsg\":\"Successful payment\"}"
}
上一页
退款Refund
下一页
预授权撤销(Void)
Built with