交易查询

• Endpoint: POST /aggregate-pay/api/gateway/orderQuery
• Tags: 收单

Description

对于未同步返回交易结果的请求，商户可以主动发起查询查回交易结果。

Parameters

Field	Type	Required	Description
Content-Type (header)	string	Yes
sign (header)	string	Yes	签名信息请参考技术文档

Request Body

Field	Type	Required	Description
version	string	Yes	接口版本 当前值为：1.5
keyVersion	string	Yes	密钥版本 当前值为：1
requestTime	string	Yes	请求时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内
appId	string	Yes	商户应用Id，PayerMax分配给商户应用的唯一标识
merchantNo	string	No	商户号，商户与PayerMax业务签约时生成的唯一标识
data	object	Yes	请求数据体
data.outTradeNo	string	Yes	原商户订单号

Responses

200 — ### 错误码

分类	结果码	结果描述
SYSTEM_ERROR	System is busy, please try again later.	系统错误；请联系PayerMax
REQ_TIME_OVER_TIME	requestTime effective in two minutes	请求时间与服务端偏差超过2分钟，请检查requestTime后重新发起
TOO_MANY_REQUEST	Exceed request limitation, please retry later	触发接口并发限流,请稍后重试
SIGN_VERIFY_FAILED	The signature verify failed.	签名错误；请核实签名
MERCHANT_INVALID	The merchant has been offline.	无效商户
MERCHANT_APP_INVALID	Signature key is not configured.	无效商户APP
PARAMS_INVALID	${field} length must be between ${min} and ${max},but your input value length is ${length}.Make sure all requests length is correct.	无效参数-入参字段长度不符合要求；请参考官网字段描述
PARAMS_INVALID	${field} must be ${type} , but your input is ${valueType}.Make sure all requests type is correct.	无效参数-入参字段类型不正确；请参考官网字段描述
PARAMS_INVALID	${field} is invalid,because ${field} is null.	无效参数-入参字段不能为空；请参考官网字段描述
ORDER_NOT_EXIST	The order does not exist.	订单不存在

Field	Type	Required	Description	Enum
code	string	Yes	返回码，’APPLY_SUCCESS’代表成功。只代表接口请求成功，不代表订单状态。
msg	string	Yes	返回描述，’Success.’。只代表接口请求成功，不代表订单状态。
data	object	No	返回数据体
data.reference	string	No	附加数据，商户上送的值
data.outTradeNo	string	No	商户订单号
data.tradeToken	string	No	PayerMax交易流水号
data.totalAmount	number	Yes	标价金额，金额的单位为元。
data.currency	string	Yes	标价币种
data.channelNo	string	No	渠道订单号
data.thirdChannelNo	string	No	三方单号
data.paymentCode	string	No	VA单号
data.country	string	Yes	用户支付的国家代码，大写字母
data.status	string	No	交易状态，详见【交易状态】
data.paymentDetails	array[object]	No	支付信息，只有交易成功会返回支付信息，当交易失败时返回空数组。
data.paymentDetails[].paymentMethodType	string	No	支付方式类型，参见【收银台支付-支付方式类型】。
data.paymentDetails[].targetOrg	string	No	目标机构，用户支付所选择的目标机构; paymentMethodType为CARD的时不返回。
data.paymentDetails[].payAmount	number	No	支付金额
data.paymentDetails[].exchangeRate	string	No	标价币种转换为支付币种的汇率
data.paymentDetails[].payCurrency	string	No	支付币种
data.paymentDetails[].paymentTokenID	string	No	绑卡支付场景下，用于支付的授权ID，默认有效期为卡有效期，可通过【removePaymentToken】接口置为无效。
data.paymentDetails[].cardInfo	object	No	卡信息
data.paymentDetails[].cardInfo.cardOrg	string	No	卡组织，只有交易成功且用户选择卡组织支付时才返回。
data.paymentDetails[].cardInfo. country	string	No	发卡国家
data.paymentDetails[].cardInfo.cardType	string	No	卡类型，DEBIT、CREDIT等。
data.paymentDetails[].cardInfo.totalCardOrg	array[string]	No	卡的所有卡组织，双标卡会返回两个。
data.paymentDetails[].cardInfo.type	string	No	卡性质。PAN为真实卡；NETWORK_TOKEN为虚拟卡，如APPLEPAY。
data.paymentDetails[].cardInfo.source	string	No	卡信息来源。CARD、APPLEPAY、GOOGLEPAY_PAN、GOOGLEPAY_CRYPTOGRAM、NETWORK_TOKEN
data.paymentDetails[].cardInfo.cardBinNo	string	No	卡bin号。
data.paymentDetails[].cardInfo.cardNumber	string	No	卡号，掩码返回。
data.paymentDetails[].cardInfo.cardHolderName	string	No	持卡人姓名，掩码返回。
data.paymentDetails[].cardInfo.cardLast4	string	No	真实卡号后四位。
data.paymentDetails[].cardInfo.cardExpirationYear	string	No	卡有效年。
data.paymentDetails[].cardInfo.cardExpirationMonth	string	No	卡有效月。
data.paymentDetails[].cardInfo.cardIdentifierNo	string	No	卡号，当paymentMethodType为CARD时掩码返回
data.paymentDetails[].cardInfo.cardIdentifierName	string	No	卡姓名，当paymentMethodType为CARD时掩码返回
data.paymentDetails[].cardInfo. paymentTokenID	string	No	绑卡支付场景下，用于支付的授权ID，默认有效期为卡有效期，可通过【removePaymentToken】接口置为无效。
data.paymentDetails[].cardInfo.threeDSResult	object	No	3ds结果
data.paymentDetails[].cardInfo.threeDSResult.threeDSVersion	string	No	3ds版本 1.0.2, 2.1.0, 2.2.0
data.paymentDetails[].cardInfo.threeDSResult.enrolled	string	No	Status of Authentication eligibility. Y - Yes, Bank is participating in 3-D Secure protocol and will return the ACSUrl N - No, Bank is not participating in 3-D Secure protocol U - Unavailable, The DS or ACS is not available for authentication at the time of the request B - Bypass, Merchant authentication rule is triggered to bypass authentication in this use case. (3DS Flex premium only)	Y, N, U, B
data.paymentDetails[].cardInfo.threeDSResult.authenticationStatus	string	No	Transactions status result identifier. Y - Successful Authentication N - Failed Authentication U - Unable to Complete Authentication A - Successful Attempts Transaction R - Authentication Rejected (Merchant must not submit for authorisation)	Y, N, U, A, R
data.paymentDetails[].cardInfo.threeDSResult.eci	string	Yes	Electronic Commerce Indicator (ECI). Possible Values: 02 or 05 - Fully Authenticated Transaction 01 or 06 - Attempted Authentication Transaction 00 or 07 - Non 3-D Secure Transaction Mastercard - 02, 01, 00 Visa - 05, 06, 07
data.paymentDetails[].cardInfo.threeDSResult.dsTransactionId	string	No	the Directory Server (DS)分配的唯一标识
data.paymentDetails[].cardInfo.threeDSResult.cavv	string	No	Cardholder Authentication Verification Value (CAVV) Authentication Verification Value (AVV) Universal Cardholder Authentication Field (UCAF)
data.paymentDetails[].cardInfo.threeDSResult.xid	string	No	身份验证结果标识
data.paymentDetails[].cardInfo.avsResult	string	No	avs结果
data.paymentDetails[].additionalData	object	No	包含有关付款的更多详细信息
data.paymentDetails[].additionalData.rrn	string	No	交易检索号
data.paymentDetails[].additionalData.authCode	string	No	发卡行授权码
data.fees	object	No	费用信息，支付成功且存在费用时才返回。
data.fees.merFee	object	No	商户税费
data.fees.merFee.url	string	Yes	发票地址，打开地址可预览发票
data.fees.merFee.amount	string	Yes	费用金额
data.fees.merFee.currency	string	Yes	费用币种
data.resultCode	string	No	交易状态结果描述
data.resultMsg	string	Yes	交易状态结果描述,仅失败时有值
data.createTime	string	No	订单创建时间
data.confirmPayTime	string	No	订单流转到外部渠道时间点
data.completeTime	string	No	订单完成时间
data.cashierCountry	string	Yes	收银台模式下，在收银台上发起支付的国家。支付成功时返回。
data.issuerResponseCode	string	No	发卡行标准错误码
data.issuerResponseMsg	string	No	发卡行标准错误描述