Balance change notification

• Endpoint: POST /balanceNotifyUrl
• Tags: Fund Account(Old)

Description

When merchant account balance changes due to recharge, transfer, exchange, withdrawal operations, we will notify through this API.

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	Callback notification code, APPLY_SUCCESS means this is a valid callback.
msg	string	Yes	maxLength: 256	Valid notification description：Success.
version	string	Yes	maxLength: 8	API version, current value 1.0
keyVersion	string	Yes	maxLength: 8	Key version, current value 1
appId	string	Yes	maxLength: 64	Merchant AppID, the unique identifier assigned to the merchant app by PayerMax.
merchantNo	string	Yes	maxLength: 15	MerchantNo, the unique identifier generated when the merchant signs the contract with PayerMax.
notifyTime	string	Yes	maxLength: 32	Notification time, in line with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
notifyType	string	Yes	maxLength: 16	DEPOSIT,EXCHANGE,WITHDRAW,TRANSFER
data	object	Yes		Response data body.
data.amount	object	Yes		Balance change
data.amount.currency	string	Yes	maxLength: 3	Currency
data.amount.value	string	Yes	maxLength: 204	Amount
data.counterparty	object	Yes		Transaction Party
data.counterparty.identifyId	string	Yes		Transaction Party label.For recharge and withdrawl, it will be bank account no, for transfer and conversion, it will be merchant ID
data.counterparty.identifyName	string	Yes		Transaction Party Name
data.direction	string	Yes		IBalance Directio：NCREASE/DECREASE
data.relatedTradeNo	string	Yes	maxLength: 64	The related PayerMax Trade Order No
data.exchange	object	No		Exchange rate information
data.exchange.ccyPair	string	Yes		Currency Conversion Fee
data.exchange.rate	string	Yes		Transaction exchange rate
data.exchange.rateTime	string	Yes		Exchange rate time
data.fee	object	No		Fee
data.fee.value	string	Yes		Fee Amount
data.fee.currency	string	Yes		Fee Currency

Example

{
  "appId": "2222fd568ab5452b906a3d65a1fbac19",
  "code": "APPLY_SUCCESS",
  "data": {
    "amount": {
      "currency": "MYR",
      "value": "448.13"
    },
    "counterparty": {
      "identifyId": "P01010113842047",
      "identifyName": "自动化商户名1661913462216"
    },
    "direction": "DECREASE",
    "exchange": {
      "ccyPair": "USDMYR",
      "rate": "4.48130000",
      "rateTime": "2022-12-12T09:26:42.000Z"
    },
    "relatedTradeNo": "20221212092644TU2586897700363059"
  },
  "keyVersion": "1",
  "merchantNo": "P01010113842047",
  "msg": "Success",
  "notifyTime": "2022-12-12T09:26:57.628Z",
  "notifyType": "EXCHANGE",
  "version": "1.0"
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
msg	string	Yes		Response message
code	string	Yes		Response code

Response Example

{
  "msg": "Success",
  "code": "SUCCESS"
}