查询记账簿 - 易宝开放平台

请求参数

Header 参数

x-yop-sdk-version

string

可选

默认值:

4.0.0

Body 参数application/json

查询记账簿请求参数

parentMerchantNo

string

必需

业务发起方商编发起方商户编号。*标准商户收付款方案中此参数与收款商户编号一致；*平台商户收付款方案中此参数为平台商商户编号；*服务商解决方案中，①标准商户收款时，该参数为标准商户商编 ②平台商收款或平台商入驻商户收款时，该参数为平台商商编。

<= 32 字符

merchantNo

string

商户编号

必需

易宝支付分配的的商户唯一标识

<= 32 字符

applyMerchantNo

string

申请方商编

可选

发起申请记账簿的商户编号

<= 32 字符

type

string

可选

TOTAL ：汇总查询,查询发起方商编下所有记账簿汇总余额(默认)

DETAIL：明细查询,查询发起方商编下某一记账簿余额

<= 32 字符

queryStartDate

string

记账簿创建开始时间

可选

type为DETAIL时必填

格式:yyyy-MM-dd HH:mm:ss，时间范围不能超过31天

<= 32 字符

queryEndDate

string

记账簿创建截止时间

可选

type为DETAIL时必填

格式:yyyy-MM-dd HH:mm:ss，时间范围不能超过31天

<= 32 字符

pageNo

integer <int32>

可选

页码,默认为1

pageSize

integer <int32>

可选

分页大小,默认50

< 200

示例

{
    "parentMerchantNo": "string",
    "merchantNo": "string",
    "applyMerchantNo": "string",
    "type": "string",
    "queryStartDate": "string",
    "queryEndDate": "string",
    "pageNo": 0,
    "pageSize": 199
}

返回响应

🟢200成功

application/json

Body

result

object (account.QueryOfflineRepayAccountRespDTO)

查询记账簿响应参数

可选

returnCode

string

返回码

必需

该参数代表本次请求的处理结果，AM00000为请求成功若请求失败参看对应错误码和错误信息

<= 32 字符

示例值:

AM00000

returnMsg

string

可选

返回信息

<= 256 字符

totalBalance

number

可选

记账簿汇总余额

发起方商编下所有记账簿可用余额，单位元，精确到两位小数

示例值:

100

totalCount

integer <int32>

可选

查询详情的总笔数

accountBookList

array[object (account.QueryOfflineRepayAccountDetail) {4}]

可选

查询详情的明细

<= 200 items

示例

{
    "result": {
        "returnCode": "AM00000",
        "returnMsg": "string",
        "totalBalance": 100,
        "totalCount": 0,
        "accountBookList": [
            {
                "merchantAccountBookNo": "string",
                "merchantAccountBookName": "string",
                "ypAccountBookNo": "string",
                "balance": 100
            }
        ]
    }
}

🔴500服务器错误