Merchant Result Confirmation

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

Description

After the merchant receives the payment notification and performs internal credit processing, it will return the final credit result to PayerMax.

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.0
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
merchantNo	string	No	maxLength: 32	Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax
merchantAppId	string	Yes	maxLength: 64	Merchant AppId，The unique identifier assigned to the merchant app by PayerMax
data	object	Yes
data.tradeToken	string	Yes	maxLength: 64	PayerMax order id.
data.referenceNo	string	Yes	maxLength: 64	The merchant's order ID of a transaction.
data.amount	number	Yes		The payment amount.
data.currency	string	Yes	maxLength: 3	The payment currency.
data.confirmation	string	Yes	maxLength: 16	The result of merchant's credit. Value: "Y" or "N".
data.failureReason	string	Yes	maxLength: 255	Reason for credit failure. Note: This field is required when confirmation is 'N'.

Example

{
  "version": "1.0",
  "keyVersion": "1",
  "requestTime": "2024-02-26T13:40:36.706Z",
  "merchantAppId": "bbd8d2639a7c4dfd8df7d00529123456",
  "merchantNo": "020110987531234",
  "data": {
    "referenceNo": "TEST100001",
    "tradeToken": "T20240131032780256123456",
    "amount": 40.85,
    "currency": "PHP",
    "confirmation": "Y",
    "failureReason": ""
  }
}

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	No
data.referenceNo	string	Yes	maxLength: 64	The merchant's order ID of a transaction.
data.tradeToken	string	Yes	maxLength: 64	PayerMax order id.

Response Example

{
  "code": "APPLY_SUCCESS",
  "msg": "Success.",
  "data": {
    "referenceNo": "PM00100001",
    "tradeToken": "T20240131032780256487268"
  }
}