Capture

• Endpoint: POST /aggregate-pay/api/gateway/capture
• 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
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	Yes
data.requestId	string	Yes		Merchant unique id.
data.outTradeNo	string	Yes		Merchant order id.
data.currency	string	Yes		Capture amount.
data.amount	number	Yes		Capture currency.

Example

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

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		Return 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

Response Example

{
  "msg": "Success.",
  "code": "APPLY_SUCCESS",
  "data": {
    "captureNo": "20230806235954ED7856775040587834005",
    "requestId": "xxxxx",
    "outTradeNo": "xxxxxxxx",
    "amount": 10,
    "currency": "SAR",
    "status": "PENDING",
    "isFinal": true,
    "createdTime": "2023-08-06T23:50:59 +0000",
    "succeededTime": null,
    "failedTime": null,
    "errorCode": null,
    "errorMsg": null
  }
}