Skip to content

余额查询

1.余额查询服务介绍

PayerMax余额查询服务为商户提供了实时余额查询和日终余额查询:

  • 实时余额查询:基于商户的请求时间、账户类型、币种查询实时的客户账余额
  • 日终余额查询:返回指定日期及时区下的余额信息

2.实时余额查询

1.接口参数 接口参数

接口名称:实时余额查询 /currentBalanceQuery

Request Parameters

参数类型是否必填最大长度描述示例值
versionStringM8接口版本。当前值为:1.21.2
requestTimeStringM32请求时间,符合rfc3339规范,格式:yyyy-MM-dd'T'HH:mm:ss.SSSXXX2022-01-22T10:00:00.500+08:00
keyVersionStringM8密钥版本。当前值为:11
merchantNoStringM15商户号,商户与PayerMax业务签约时生成的唯一标识10229810189301
appIdStringM64商户应用Id,PayerMax分配给商户应用的唯一标识46153e2b787241ae8b01857bb087d1bd
+dataobjectM32请求数据体
「plainSignboolean O是否展示余额为0的账户 -true展示 -false不展示(默认),直接过滤该账户 false
「accountTypeListO账户类型: -ACQUIRING 收单账户 -DISBURSEMENT 代发账户(原AVAILABLE) -FREEZE 冻结账户 -SETTLE 待结算账户 -REVERSE 保证金账户 当未指定账户类型时,返回全部不为0的账户 AVAILABLE
「accountCurrencyList O323位币种代码,符合ISO 4217规范. 当未指定币种时,返回全部不为0的账户 USD
> Response Parameters
参数类型是否必填最大长度描述示例值
codeStringM32接口响应码,'APPLY_SUCCESS'代表成功APPLY_SUCCESS
msgStringM256响应描述,'Success.'Success
+dataobjectc返回数据体
「inquiryTimeStringM64查询时间 ,符合rfc3339规范,格式:yyyy-MM-dd’T’HH:mm:ss.SSSXXX2022-01-22T10:00:00.500+08:00
+AccountRealTimeTypeList M64
-accountTypeStringO32账户类型AVAILABLE
-balanceSBigDecimalO(20,2)金额 单位元A9998.00
-currencyStringO33位币种代码,符合ISO 4217规范.USD
「errorCodeStringC32查询失败错误码
「errorMsgStringC256查询失败错误码描述

2.示例代码

商户请求参数

json
{
  "version": "1.2",
  "keyVersion": "1",
  "requestTime": "2022-01-12T20:31:20.000+0800",
  "appId": "41c4f31f487a42b7996979e775c3d7bc",
  "merchantNo": "010113855475499",
  "data": {
    "plainSign": true,
    "accountCurrency": [
      "EGP"
    ],
    "accountType": [
      "AVAILABLE",
      "FREEZE",
      "SETTLE",
      "REVERSE"
    ]
  }
}

返回参数

json
{
  "msg": "",
  "code": "APPLY_SUCCESS",
  "data": {
    "accountRealTimeTypes": [
      {
        "balance": 18277.20,
        "accountType": "SETTLE",
        "currency": "EGP"
      }
    ],
    "inquiryTime": "2023-02-23T07:47:05.940Z"
  }
}

3.日终余额查询

1.接口参数 接口参数

接口名称:日终余额查询 /dayEndBalanceQuery

Request Parameters

参数类型是否必填最大长度描述示例值
versionStringM8接口版本。当前值为:1.21.2
requestTimeStringM32请求时间,符合rfc3339规范,格式:yyyy-MM-dd'T'HH:mm:ss.SSSXXX2022-01-22T10:00:00.500+08:00
keyVersionStringM8密钥版本。当前值为:11
merchantNoStringM15商户号,商户与PayerMax业务签约时生成的唯一标识10229810189301
appIdStringM64商户应用Id,PayerMax分配给商户应用的唯一标识46153e2b787241ae8b01857bb087d1bd
+dataobjectM32请求数据体
「accountTypeList O账户类型: -ACQUIRING 收单账户 -DISBURSEMENT 代发账户(原AVAILABLE) -FREEZE 冻结账户 -SETTLE 待结算账户 -REVERSE 保证金账户 当未指定账户类型时,返回全部 AVAILABLE
「accountCurrencyStringO323位币种代码,符合ISO 4217规范. 当未指定币种时,返回全部 IDR
「inquiryDateStringM32支持查询近90天 "2023-01-01"
「timezoneStringM32时区 目前只支持(UTC 、CST) CST
>Response Parameters
参数类型是否必填最大长度描述示例值
codeStringM32接口响应码,'APPLY_SUCCESS'代表成功APPLY_SUCCESS
msgStringM256响应描述,'Success.'Success
+dataobjectc返回数据体
「timezoneStringM32时区CST
「acctTimeStringM63对应余额的时间 ,符合rfc3339规范,格式:yyyy-MM-dd’T’HH:mm:ss.SSSXXX2022-01-22T10:00:00.500+08:00
+accountEndDayTimeTypesList M账户类型结果,查询到的账户类型
-accountTypeStringM32账户类型AVAILABLE
-currencyStringM33位币种代码,符合ISO 4217规范. 当未指定币种时,返回全部余额大于0的币种 IDR
-initalBalanceBigDecimalM(20,4)期初余额 43820.00
-endBalanceBigDecimalM(20,4)期末余额 1157812.00
-inflowAmountBigDecimalM(20,4)期间流出发生额 当日内流入金额 0.00
-outflowAmountBigDecimalM(20,4)期间流入发生额 当日内流出金额 1201632.00
「errorCodeStringc32订单失败错误码
「errorMsgStringc256订单失败错误码描述

2.示例代码

日终余额查询请求

json
{
  "version": "1.2",
  "keyVersion": "1",
  "requestTime": "2022-01-12T20:31:20.000+0800",
  "appId": "41c4f31f487a42b7996979e775c3d7bc",
  "merchantNo": "010113855475499",
  "data": {
    "accountCurrency": "TRY",
    "accountType": [
      "AVAILABLE"
    ],
    "inquiryDate": "2023-02-20",
    "timezone": "utc"
  }
}

日终余额查询响应

json
{
  "msg": "",
  "code": "APPLY_SUCCESS",
  "data": {
    "acctTime": "2023-02-22",
    "timezone": "GMT+0:00",
    "accountEndDayTimeTypes": [
      {
        "accountType": "AVAILABLE",
        "currency": "TRY",
        "inflowAmount": 0.00,
        "initalBalance": 0.00,
        "endBalance": 0.00,
        "outflowAmount": 0.00
      }
    ]
  }
}

4.账户类型

账户类型说明
ACQUIRING 收单余额账户存放通过收单业务,并且达到结算周期的资金的账户
DISBURSEMENT 代发余额户存放通过充值或结算转充值转入,可以用作代发的资金的账户(原AVAILABLE可用余额户)
FREEZE 冻结账户存放因产生争议或风控而被冻结的资金的账户
SETTLE 待结算账户存放未到达结算周期及未结算出款的资金的账户
REVERSE保证金账户存放保证金的账户

此页面的内容有帮助吗?

感谢您帮助改进 PayerMax 产品文档!

Last updated:

Released under the MIT License.