Payment Confirm

• Endpoint: POST /aggregate-pay/api/gateway/confirmPayment
• Tags: Collection Service

Description

Support interface for merchants to proactively confirm payment.

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		API version. Current value: 1.5
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
requestTime	string	Yes		Request time, compliant with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX The time must be within two minutes of the current time
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
data	object	No		Request data body
data.outTradeNo	string	Yes	maxLength: 64	Merchant order id, a transaction that uniquely identifies a merchant, cannot be repeated, and can only contain letters, numbers, and underscores.
data.tradeToken	string	Yes	maxLength: 64	PayerMax tradeToken
data.paymentDetail	object	Yes
data.paymentDetail.verificationCode	string (char)	Yes	maxLength: 32, minLength: 1, pattern: ^[A-Za-z0-9]+$	OTP

Example

{
  "version": "1.5",
  "keyVersion": "1",
  "requestTime": "2023-08-22T12:40:06.840Z",
  "appId": "a0dddd1f622243cb9aa1b676e808b5f8",
  "merchantNo": "02021382719993",
  "data": {
    "outTradeNo": "APIFOXDEV1759988765500077",
    "tradeToken": "T2025072902513478000003",
    "paymentDetail": {
      "verificationCode": "99888"
    }
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success
msg	string	Yes		Return message, ‘Success.’
data	object	Yes
data.outTradeNo	string	Yes	maxLength: 64	Merchant order id, a transaction that uniquely identifies a merchant, cannot be repeated, and can only contain letters, numbers, and underscores.
data.closedTime	string	Yes	maxLength: 64	Order closed time
data.status	string	Yes	maxLength: 32	Transaction Status，See【Transaction Status】

Response Example

{
  "code": "APPLY_SUCCESS",
  "msg": "Success.",
  "data": {
    "status": "SUCCESS"
  }
}