Skip to navigation
API ReferenceCompany

List Wallet Ledger

Returns your company’s SalaryBox wallet history, newest first: every top-up, every spend (for example staff verification charges) and every expiry of balance. It is the same list as Wallet history in the app.

  • amount is a 2-decimal string, positive when money came in (a top-up or promo credit) and negative when it went out (a spend or expiry).
  • balance_after is the total balance (normal plus promo) right after the entry. To get the current balance, read balance_after on the first row of page 1.
  • type is normal for money your company added, or promo for credit from SalaryBox, which can be used only for staff verification and can expire.
  • action is the label shown in the app, for example Topup or Staff Verification (XXXXXX9999). Phone numbers in labels are masked.

start_date and end_date are optional and each can be used alone. Both are whole days in your company’s time zone, and the range must be shorter than 366 days.

Errors

  • 503 "Wallet ledger is temporarily unavailable, please try again": the wallet service could not be reached. Retry after a short while.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

start_datedateOptional

First day to include, YYYY-MM-DD. Optional.

end_datedateOptional

Last day to include, YYYY-MM-DD. Optional. Must not be before start_date.

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 200.

Response

Wallet entries, newest first. Empty data and count 0 if the company has never used the wallet.

datalist of objects
messagestringOptional
statusbooleanOptional
countintegerOptional
Total number of results across all pages.
prevstring or nullOptional
URL of the previous page, or null.
nextstring or nullOptional
URL of the next page, or null.

Errors

400
Bad Request Error
404
Not Found Error
503
Service Unavailable Error