查询余额流水

使用此端点按筛选条件查询余额流水。

可用环境

生产环境

https://api.gateway.com.br/core

端点

• 方法：GET
• 端点：/wallet/ledger-entry
• 认证方式：Bearer token

查询参数

ℹ️ 使用 ISO 日期

startDate 和 endDate 必须以带时间的 ISO date string 格式传入。

示例：

• 2026-03-06T12:00:00.000Z

ℹ️ snapshot 分页

snapshot 不是指向“下一页”的指针：它是分页会话的固定标识，与 page（仍需照常传入并递增）配合使用，即使在翻页过程中产生了新记录，也能保持结果一致。

请从第一次响应中取得 snapshot 的值（第一次请求不传 snapshot），并在后续页面的请求中原样重新传回该值，同时保持与最初请求相同的筛选条件和相同的 perPage。如果在重新传回旧的 snapshot 时其中任一值发生变化，接口会返回错误。

名称	类型	必填	说明	校验规则
snapshot	string	否	分页会话的标识（取自第一次响应的 snapshot 字段）；后续页面请随 page 一起原样传回	必须与最初请求的筛选条件和 perPage 一致
startDate	string	否	筛选的起始日期	必须为带时间的 ISO date string
endDate	string	否	筛选的结束日期	必须为带时间的 ISO date string
type	string[] (enum) - CREDIT, DEBIT	否	用于筛选的类型列表	必须为非空且不含重复项的数组

请求示例

cURL

curl --request GET \
--url https://api.gateway.com.br/core/wallet/ledger-entry?type=DEBIT&startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z \
--header 'Authorization: Bearer your-jwt-token'

JavaScript

const params = new URLSearchParams({
  startDate: '2026-03-06T00:00:00.000Z',
  endDate: '2026-03-06T23:59:59.999Z'
});
params.append('type', 'DEBIT');

const response = await fetch(`https://api.gateway.com.br/core/wallet/ledger-entry?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});
const data = await response.json();

成功响应

字段	类型	必填	说明
totalPages	number	是	总页数
currentPage	number	是	当前页
perPage	number	是	每页条数
snapshot	string	否	分页会话的标识；后续页面请原样传回
data	array	是	列表

data 中每一项的字段

字段	类型	必填	说明
id	string (UUID)	是	唯一标识
transactionId	string (UUID)	是	交易的唯一标识
amount	number	是	金额，以分为单位，可能带有小数部分
balanceBefore	number	是	变动前余额，以分为单位，可能带有小数部分
balanceAfter	number	是	变动后余额，以分为单位，可能带有小数部分
type	string (enum) - CREDIT, DEBIT	是	类型
description	string	是	事件说明
date	string	是	事件时间

响应示例

{
  "totalPages": 1,
  "currentPage": 1,
  "perPage": 15,
  "snapshot": "b3BhcXVlLXNuYXBzaG90LXRva2Vu",
  "data": [
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "amount": 10000,
      "balanceBefore": 50000,
      "balanceAfter": 60000,
      "type": "CREDIT",
      "description": "Transaction payment",
      "date": "2026-03-06T12:49:04.681Z"
    },
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "amount": 1000,
      "balanceBefore": 60000,
      "balanceAfter": 59000,
      "type": "DEBIT",
      "description": "Transaction payment - Fee",
      "date": "2026-03-06T12:49:04.681Z"
    },
    {
      "id": "553e8400-e29b-41d4-a716-436251480000",
      "transactionId": "553e8400-e29b-41d4-a716-436251480000",
      "amount": 2000,
      "balanceBefore": 59000,
      "balanceAfter": 57000,
      "type": "DEBIT",
      "description": "Transaction payment - Reserve",
      "date": "2026-03-06T12:49:04.681Z"
    }
  ]
}

可能的错误

状态码	说明	处理方式
401	凭据无效	请检查您的凭据
403	无权限或未授权	请联系技术支持
422	数据无效或缺失	请检查数据格式
500	内部错误	请联系技术支持