Get all ledger entries - HelloPay API Documentation

GET

/

ledger

/

entries

{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "reason": "<string>",
      "preAvailableBalance": 123,
      "postAvailableBalance": 123,
      "prePostedBalance": 123,
      "postPostedBalance": 123,
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": false
  }
}

Query Parameters

page

number

default:1

Page number for pagination

Required range: x >= 1

Example:

1

limit

number

default:10

Number of items per page

Required range: x >= 1

Example:

10

total

number

default:100

Total number of items

Required range: x >= 1

Example:

100

totalPages

number

default:10

Total number of pages

Required range: x >= 1

Example:

10

hasNext

boolean

default:true

Whether there is a next page

Example:

true

hasPrev

boolean

default:false

Whether there is a previous page

Example:

false

Response

List of ledger entries with pagination

data

object[]

required

The data of the ledger entries

Show child attributes

data.id

string

required

The ID of the ledger entry

data.createdAt

string<date-time>

required

The creation date of the ledger entry

data.updatedAt

string<date-time>

required

The update date of the ledger entry

data.amount

number

required

The amount of the ledger entry

data.currency

string

required

The currency of the ledger entry

data.reason

string

required

The reason of the ledger entry

data.preAvailableBalance

number

required

The pre available balance of the ledger entry

data.postAvailableBalance

number

required

The post available balance of the ledger entry

data.prePostedBalance

number

required

The pre posted balance of the ledger entry

data.postPostedBalance

number

required

The post posted balance of the ledger entry

data.metadata

object

required

The metadata of the ledger entry

pagination

object

required

The pagination metadata

Show child attributes

pagination.page

number

default:1

Page number for pagination

Required range: x >= 1

Example:

1

pagination.limit

number

default:10

Number of items per page

Required range: x >= 1

Example:

10

pagination.total

number

default:100

Total number of items

Required range: x >= 1

Example:

100

pagination.totalPages

number

default:10

Total number of pages

Required range: x >= 1

Example:

10

pagination.hasNext

boolean

default:true

Whether there is a next page

Example:

true

pagination.hasPrev

boolean

default:false

Whether there is a previous page

Example:

false

Get the current balanceRetrieves the current balance.

⌘I

{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "reason": "<string>",
      "preAvailableBalance": 123,
      "postAvailableBalance": 123,
      "prePostedBalance": 123,
      "postPostedBalance": 123,
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": false
  }
}