Day end balance query

• Endpoint: POST /aggregate-pay/api/gateway/dayEndBalanceQuery
• Tags: Fund Account(Old)

Description

returns the balance information under the specified date and time zone

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.3
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		Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax
data	object	Yes
data.accountCurrency	string	No	maxLength: 3	3-digit currency code in accordance with ISO 4217 When no currency is specified, returns All
data.accountType	array[string]	No		-ACQUIRING Available Balance Account -DISBURSEMENT Available Balance Account When no account type is specified, returns All
data.inquiryDate	string	Yes	maxLength: 32	Support query for nearly 90 days
data.timezone	string	Yes	maxLength: 32	Time zone is currently only supported (UTC, CST).Case-insensitive

Example

{
  "version": "1.3",
  "keyVersion": "1",
  "requestTime": "{{requestTime}}",
  "appId": "f79e7cd18fbc43e3a085adab88b9d61f",
  "merchantNo": "SP12106963",
  "data": {
    "accountCurrency": "usd",
    "accountType": [],
    "inquiryDate": "2023-06-20",
    "timezone": "utc"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
data	object	Yes
data.timezone	string	Yes	maxLength: 32	Time zone is currently only supported (UTC, CST).
data.acctTime	string	Yes	maxLength: 63	The time of the corresponding balance conforms to RFC3339 specification, format: yyyy-mm-dd’T’HH:mm:ss. SSSXXX
data.accountEndDayTimeTypes	array[object]	Yes		the type of account queried
data.accountEndDayTimeTypes[].inflowAmount	number (20,2)	Yes		Period outflow amount The amount of inflow during the day
data.accountEndDayTimeTypes[].initalBalance	number (20,2)	Yes		Opening balance
data.accountEndDayTimeTypes[].endBalance	number (20,2)	Yes		Closing balance Calculation Formula: endBalance = initalBalance + inflowAmount - outflowAmount
data.accountEndDayTimeTypes[].accountType	string	Yes	maxLength: 32	Account Type
data.accountEndDayTimeTypes[].currency	string	Yes	maxLength: 3	33-digit currency code in accordance with ISO 4217 When no currency is specified, all currencies with balances greater than 0 are returned
data.accountEndDayTimeTypes[].outflowAmount	number (20,2)	Yes		Period inflow amount The amount of outflow during the day
data.errorCode	string	Yes	maxLength: 32
data.errorMsg	string	Yes	maxLength: 256
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success
msg	string	Yes		Return message, ‘Success.’

Response Example

{
  "msg": "",
  "code": "APPLY_SUCCESS",
  "data": {
    "acctTime": "2023-02-20",
    "timezone": "CST",
    "accountEndDayTimeTypes": [
      {
        "inflowAmount": 0,
        "initalBalance": 43820,
        "endBalance": 33820,
        "accountType": "DISBURSEMENT",
        "currency": "IDR",
        "outflowAmount": 10000
      },
      {
        "inflowAmount": 0,
        "initalBalance": 0,
        "endBalance": 0,
        "accountType": "DISBURSEMENT",
        "currency": "EGP",
        "outflowAmount": 0
      },
      {
        "inflowAmount": 0,
        "initalBalance": 0,
        "endBalance": 0,
        "accountType": "DISBURSEMENT",
        "currency": "MYR",
        "outflowAmount": 0
      },
      {
        "inflowAmount": 0,
        "initalBalance": 0,
        "endBalance": 0,
        "accountType": "DISBURSEMENT",
        "currency": "PHP",
        "outflowAmount": 0
      }
    ]
  }
}