Subscription Result Notification

• Endpoint: POST /subscriptionResultNotifyUrl
• Tags: Collection Service/Subscription Management

Description

When a subscription's status changes, PayerMax will notify the merchant of the current subscription status.

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
code	string	Yes	maxLength: 32	Return Code. When the transaction is successful, code: APPLY_SUCCESS and status: SUCCESS; If the transaction fails, the code will return a transaction failure error code and the status is FAILED or CLOSED.
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
appId	string	Yes		Merchant AppId，The unique identifier assigned to the merchant app by PayerMax
merchantNo	string	No	maxLength: 32	Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax
msg	string	Yes	maxLength: 256	Return Message. When the transaction is successful, msg:Success. and status: SUCCESS; If the transaction fails, msg will return the transaction failure error msg and the status is FAILED or CLOSED.
notifyTime	string	Yes	maxLength: 32	Notification time，Compliant with rfc3339 specification, format：yyyy-MM-dd’T’HH:mm:ss.SSSXXX
notifyType	string	Yes	maxLength: 16	Notification Type:SUBSCRIPTION
data	object	Yes
data.subscriptionRequestId	string	Yes	maxLength: 64	Merchant's unique request ID for subscription plan creation.
data.userId	string	Yes	maxLength: 64	User ID.
data.subscriptionPlan	object	Yes		Subscription plan detail.
data.subscriptionPlan.subscriptionNo	string	Yes	maxLength: 64	PayerMax subscription plan ID.
data.subscriptionPlan.subscriptionStatus	string	Yes	maxLength: 32	Subscription plan status. INACTIVE: Not activated ACTIVE_FAILED: Activation failed ACTIVE: Activation is successful EXPIRED: Expired and not activated FINISH: Subscription Completed CANCEL: Subscription Cancel TERMINATE: Subscription termination

Example

{
  "code": "APPLY_SUCCESS",
  "msg": "",
  "keyVersion": "1",
  "appId": "3b242b56a8b64274bcc37dac281120e3",
  "merchantNo": "020213827212251",
  "notifyTime": "2022-01-17T09:33:54.540+00:00",
  "notifyType": "SUBSCRIPTION",
  "data": {
    "subscriptionRequestId": "testRequestId0001",
    "userId": "testUserId0001",
    "subscriptionPlan": {
      "subscriptionNo": "SUB20250417120949065211234",
      "subscriptionStatus": "ACTIVE"
    }
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes	maxLength: 32	Response ‘SUCCESS’(Only means that the callback response is successful)
msg	string	No	maxLength: 256	Response’Success’(Only means that the callback response is successful)

Response Example

{
  "code": "SUCCESS",
  "msg": "Success"
}