Capture Notifications

• Endpoint: POST /captureResultNotifyUrl
• Tags: Collection Service/Auth Capture

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 CAPTURE
data	object	Yes		Notify data body
data.captureNo	string	Yes	maxLength: 64	PayerMax capture order id
data.requestId	string	Yes	maxLength: 64	Merchant unique id.
data.outTradeNo	string	Yes	maxLength: 32	Merchant order id.
data.amount	string	Yes	maxLength: 1024	Capture amount.
data.currency	string	Yes		Capture currency.
data.status	string	Yes		Capture status. SUCCESS、FAILED 、PENDING
data.isFinal	string	Yes		Is final capture. True,False
data.createdTime	string	Yes		Create time
data.succeededTime	string	No		Success Time
data.failedTime	string	No		Failed Time
data.errorCode	string	No		Capture status result description, only has a value when it fails
data.errorMsg	string	No		Capture status result code, only has a value when it fails

Example

{
  "keyVersion": "1",
  "appId": "5f843bfc8cec49c2b8e9e99847325548",
  "merchantNo": "P01010114418097",
  "notifyTime": "2023-07-23T00:00:01 +0000",
  "notifyType": "CAPTURE",
  "data": {
    "captureNo": "20230806235954ED7856775040587834005",
    "requestId": "xxxxx",
    "outTradeNo": "xxxxxxxx",
    "status": "SUCCESS",
    "isFinal": true,
    "createdTime": "2023-08-06T23:50:59 +0000",
    "succeededTime": "2023-08-06T23:50:59 +0000",
    "failedTime": null,
    "errorCode": null,
    "errorMsg": null
  }
}

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"
}