撤销

• Endpoint: POST /aggregate-pay/api/gateway/cancel
• Tags: 收单/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
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.requestId	string	Yes	maxLength: 64	商户撤销请求的唯一id
data.outTradeNo	string	Yes	maxLength: 64	商户订单号

Example

{
  "version": "1.5",
  "keyVersion": "1",
  "requestTime": "2024-11-06T11:56:13.000+08:00",
  "appId": "8f8b0895b60f41abbdb05405052971c8",
  "merchantNo": "P01010114178824",
  "data": {
    "requestId": "xxxxx",
    "outTradeNo": "xxxxxxxx"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes		返回码，’APPLY_SUCCESS’代表成功。只代表接口请求成功，不代表订单状态。
msg	string	Yes		返回描述，’Success.’。只代表接口请求成功，不代表订单状态。
data	any	No		返回数据体

Response Example

{
  "msg": "Success.",
  "code": "APPLY_SUCCESS",
  "data": {
    "cancelNo": "20230806235954ED7856775040587834005",
    "requestId": "xxxxx",
    "outTradeNo": "xxxxxxxx",
    "status": "SUCCESS",
    "createdTime": "2023-08-06T23:50:59 +0000",
    "succeededTime": null,
    "failedTime": null,
    "errorCode": null,
    "errorMsg": null
  }
}