Skip to main content

Query


You can query information about consumption transactions and refund transactions.

Info

{domain}/Servlet/JSAPIService.do POST

https://vmp.eftpay.com.cn/VMP/Servlet/JSAPIService.do

NameTypeDescriptionRequired
serviceStringInterface name, see Supported Services
querytypeString(30)Query type, fixed: OUT_TRADE
out_trade_noString(28)Merchant order number
refund_noString(28)Merchant refund number, used when querying refund transactions
user_confirm_keyString(12)User Key provided by eftPay
paytypeString(6)Payment type, see Supported Payment Types
buyertypeString(7)Device type: ios, android, others
payment_typeString(20)Wallet type, see Supported Wallet Types
timeStringTime, format: yyyyMMddHHmmss
signString(64)Signature

Tips

When refund_no is not provided or is "", it returns the order information based on out_trade_no, where trade_status represents the status of a consumption order. Otherwise, it returns the refund information based on refund_no, where trade_status represents the status of a refund order.

Supported services and their corresponding paytype and payment_type

Here is the mapping between service, paytype, and payment_type:

servicepaytypepayment_typeDescription
service.alipay.qrcode.QueryAlipayALIPAYCN
ALIPAYHK
ALIPAYBOTH
Alipay qrcode Query API
service.wechat.qrcode.QueryWeChatWECHATCN
WECHATHK
WeChat qrcode Query API
service.atome.v1.qrcode.QueryATOMEATOMEATOME qrcode Query API
service.unionpay.qrcode.csb.QueryUnionPayUNIONPAYUnionPay qrcode Query API
api.service.gbpay.qrcode.cash.QueryGBPAYGBPAYGBPAY qrcode Query API
service.payme.qrcode.QueryPAYMEPAYMEPAYME qrcode Query API
service.fps.qrcode.QueryFPSFPSFPS qrcode Query API

NameTypeDescriptionRequest
return_statusString(3)Return status code, represents . Note: This parameter cannot be used as a judgment of whether the transaction status is successful
Other status codes see Appendix 3
return_charString(100)Return explanation, may change, cannot be used as a conditional judgment
Return when return_status > 00
timeStringTime, format: yyyyMMddHHmmss
return_status >= 00 when returned
signString(64)Signature
return_status >= 00 when returned

NameTypeDescriptionRequest
out_trade_noString(28)Merchant order number
extra_trade_noString(28)Merchant refund number, return when refund is queried
eftpay_trade_noString(28)eftPay order number
trade_statusString(32)Trade status, see Appendix 2
user_confirm_keyString(12)User Key, provided by eftPay
trade_typeString(10)Order type, see Appendix 4
buyer_idString(30)User identifier
tidString(20)Terminal number, returned when sent during consumption request
transaction_idString(64)Payment provider number
payment_typeString(8)Wallet type
trade_timeStringTrade time, format: yyyy-MM-dd HH:mm:ss
transaction_amountString(8)Transaction amount.
Consumption amount when querying consumption; refund amount when querying refund
currencyString(10)Currency
original_amountString(8)Original transaction amount, returned when refund is queried
rateString(10)Exchange rate, returned for GBPAY type
actual_total_feeString(12)Actual payment amount, returned for GBPAY type
actual_total_fee_typeString(10)Actual payment currency, returned for GBPAY type
payment_amountString(12)Merchant's actual receipt amount, returned for UnionPay type
cost_amountString(12)User's payment amount, returned for UnionPay type
uplan_discountString(12)Uplan discount amount, returned for UnionPay type
amount_discountString(12)Instant discount amount, returned for UnionPay type

{
    "service": "service.alipay.qrcode.Query",
    "user_confirm_key": "12345678",
    "out_trade_no": "201908241040035",
    "sign": "24db1adc94b18a416796695a3062398bf3908bff7647da4948b769bf118dff87",
    "time": "20190824104052",
    "paytype": "WeChat",
    "payment_type": "WECHATCN",
    "buyertype": "ios",
    "querytype": "OUT_TRADE"
}

{
    "return_status": "00",
    "return_char": "",
    "sign": "6077b275107676aac219cb38d7970a8f3de607f47d6baa6320f337a4ca1358e2",
    "time": "20190824104135",
    "out_trade_no": "201908241040035",
    "eftpay_trade_no": "08520005269190824104101935",
    "trade_status": "TRADE_SUCCESS",
    "user_confirm_key": "12345678",
    "trade_type": "SALE",
    "buyer_id": "2088012867786450",
    "tid": "tid123",
    "transaction_id": "2019082422001486450540740143",
    "payment_type": "WECHATCN",
    "trade_time": "2019-08-24 10:41:25",
    "transaction_amount": "0.02",
    "currency": "HKD",
    "original_amount": "10.01"
}