订阅结果查询

• Endpoint: POST /aggregate-pay/api/gateway/subscriptionQuery
• 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.subscriptionRequestId	string	No	商户创建订阅计划的单号。注：subscriptionNo和requestId至少传一个。
data.subscriptionNo	string	No	PMMAX订阅计划号。注：subscriptionNo和requestId必须传一个

Responses

200

Field	Type	Required	Description
code	string	Yes	返回码，’APPLY_SUCCESS’代表成功
msg	string	Yes	返回描述，’Success.’
data	object	Yes
data.subscriptionRequestId	string	Yes	商户创建订阅计划的单号。
data.merchantNo	string	Yes	商户号。
data.userId	string	Yes	用户号。
data.subscriptionPlan	object	Yes
data.subscriptionPlan.subscriptionNo	string	Yes	PMMAX订阅号。
data.subscriptionPlan.subscriptionStatus	string	Yes	订阅计划状态。 INACTIVE：未激活 EXPIRED：过期未激活 ACTIVE_FAILED：激活失败 ACTIVE：激活成功 FINISH：订阅完成 CANCEL：订阅取消 TERMINATE：订阅终止
data.subscriptionPaymentDetails	array[object]	No
data.subscriptionPaymentDetails[].subscriptionIndex	number	No	扣款期数。
data.subscriptionPaymentDetails[].paymentStatus	string	No	本期订单状态。
data.subscriptionPaymentDetails[].periodStartTime	string	No	本期开始时间。如：2025-01-13T15:59:59+0000
data.subscriptionPaymentDetails[].periodEndTime	string	No	本期结束时间，如：2025-02-13T15:59:59+0000。
data.subscriptionPaymentDetails[].payAmount	object	No	支付金额。
data.subscriptionPaymentDetails[].payAmount.amount	number	No	金额。
data.subscriptionPaymentDetails[].payAmount.currency	string	No	币种。
data.subscriptionPaymentDetails[].paymentMethodType	string	No	支付方式。
data.subscriptionPaymentDetails[].cardOrg	string	No	卡组。
data.subscriptionPaymentDetails[].lastPaymentInfo	object	No	本期最新一次支付详情。
data.subscriptionPaymentDetails[].lastPaymentInfo.lastPaymentStatus	string	No	支付结果。 PENDING：支付中 SUCCESS：支付成功 FAILED：支付失败
data.subscriptionPaymentDetails[].lastPaymentInfo.payTime	string	No	支付时间，如：2025-01-12T15:59:59+0000。
data.subscriptionPaymentDetails[].lastPaymentInfo.tradeToken	string	No	支付单号，可用于退款。 注：成功时必有该值。
data.subscriptionPaymentDetails[].lastPaymentInfo.errorCode	string	No	扣款失败code。
data.subscriptionPaymentDetails[].lastPaymentInfo.errorMsg	string	No	扣款失败msg。
data.subscriptionPaymentDetails[].cardInfo	object	No	卡信息
data.subscriptionPaymentDetails[].cardInfo.cardOrg	string	No	卡组织，当paymentMethodType为CARD时返回，只有交易成功且用户选择卡组织支付时才返回
data.subscriptionPaymentDetails[].cardInfo.country	string	No	发卡国家
data.subscriptionPaymentDetails[].cardInfo.cardType	string	No	卡类型，DEBIT、CREDIT等。
data.subscriptionPaymentDetails[].cardInfo.totalCardOrg	array[string]	No	卡的所有卡组织，双标卡会返回两个。
data.subscriptionPaymentDetails[].cardInfo.type	string	No	卡性质。PAN为真实卡；NETWORK_TOKEN为虚拟卡，如APPLEPAY。
data.subscriptionPaymentDetails[].cardInfo.source	string	No	卡信息来源。CARD、APPLEPAY、GOOGLEPAY_PAN、GOOGLEPAY_CRYPTOGRAM、NETWORK_TOKEN
data.subscriptionPaymentDetails[].cardInfo.cardBinNo	string	No	卡bin号。
data.subscriptionPaymentDetails[].cardInfo.cardNumber	string	No	卡号，掩码返回。
data.subscriptionPaymentDetails[].cardInfo.cardHolderName	string	No	持卡人姓名，掩码返回。
data.subscriptionPaymentDetails[].cardInfo.cardLast4	string	No	真实卡号后四位。
data.subscriptionPaymentDetails[].cardInfo.cardExpirationYear	string	No	卡有效年。
data.subscriptionPaymentDetails[].cardInfo.cardExpirationMonth	string	No	卡有效月。