订阅结果查询

• Endpoint: POST /aggregate-pay/api/gateway/subscriptionQuery
• Tags: 收单/订阅计划管理

Description

商户创建订阅计划后，可通过此接口查询订阅状态和扣款信息。

Parameters

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

Parameter Examples

• Content-Type: "application/json"
• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
version	string	Yes	maxLength: 8	接口版本 当前值为：1.5
keyVersion	string	Yes	maxLength: 8	密钥版本 当前值为：1
requestTime	string	Yes	maxLength: 32	请求时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内
appId	string	Yes	maxLength: 64	商户应用Id，PayerMax分配给商户应用的唯一标识
merchantNo	string	No	maxLength: 32	商户号，商户与PayerMax业务签约时生成的唯一标识
data	object	Yes
data.subscriptionRequestId	string	No	maxLength: 64	商户创建订阅计划的单号。注：subscriptionNo和requestId至少传一个。
data.subscriptionNo	string	No	maxLength: 64	PMMAX订阅计划号。注：subscriptionNo和requestId必须传一个

Example

{
  "version": "1.5",
  "keyVersion": "1",
  "requestTime": "2025-02-26T05:00:00+00:00",
  "appId": "6666c8b036a245799744912345a123456",
  "merchantNo": "010213834123456",
  "data": {
    "subscriptionRequestId": "testRequestId0001",
    "subscriptionNo": "SUB20250417120949065211234"
  }
}

Responses

200

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

Response Example

{
  "code": "APPLY_SUCCESS",
  "msg": "Success.",
  "data": {
    "subscriptionRequestId": "testRequestId0001",
    "merchantNo": "010213834123456",
    "userId": "testUserId0001",
    "subscriptionPlan": {
      "subscriptionNo": "SUB20250417120949065211234",
      "subscriptionStatus": "ACTIVE"
    },
    "subscriptionPaymentDetails": [
      {
        "subscriptionIndex": 0,
        "paymentStatus": "SUCCESS",
        "periodStartTime": "2025-01-13T15:59:59+0000",
        "periodEndTime": "2025-02-13T15:59:59+0000",
        "payAmount": {
          "amount": 128.39,
          "currency": "USD"
        },
        "paymentMethodType": "CARD",
        "cardOrg": "VISA",
        "lastPaymentInfo": {
          "tradeToken": "T20250417174800970112345",
          "lastPaymentStatus": "SUCCESS",
          "payTime": "2025-01-12T15:59:59+0000"
        }
      },
      {
        "subscriptionIndex": 1,
        "paymentStatus": "SUCCESS",
        "periodStartTime": "2025-02-13T15:59:59+0000",
        "periodEndTime": "2025-03-13T15:59:59+0000",
        "payAmount": {
          "amount": 128.39,
          "currency": "USD"
        },
        "paymentMethodType": "CARD",
        "cardOrg": "VISA",
        "lastPaymentInfo": {
          "tradeToken": "T20250417174800970112346",
          "lastPaymentStatus": "SUCCESS",
          "payTime": "2025-02-12T15:59:59+0000"
        }
      }
    ]
  }
}