PIpismo
Account balances

Get daily account balance limits

Get daily account balance limits for a date range. By default, if only the account ID is specified, the range is 10 days: from 10 days before yesterday's date to yesterday.

You can query the account balance limits as far back as 515 days before the current date and for a maximum range of 90 days. You can't query for today's date.

Refer to the Get daily account balance limits section in the Accounts guide for more information.

get/v1/accounts/{accountId}/daily-balances

Request

  • Base URL
    https://sandbox.pismolabs.io/balances-limits
  • URL
    https://sandbox.pismolabs.io/balances-limits/v1/accounts/{accountId}/daily-balances
  • Auth
    HTTP bearer

Path parameters

accountIdnumber required
Example:123456

Account ID

Query parameters

beginDatestring date
Example:2022-01-02

Beginning date to filter account balances in the yyyy-mm-dd format. This date must be before or equal to endDate. If the value is not sent in the request, the default is endDate - 10 days.

endDatestring date
Example:2022-01-05

Ending date to filter account balances in the yyyy-mm-dd format. This date must be after or equal to the beginDate and it must be in the past, yesterday or earlier. Only full/complete days are considered. If the value is not sent in the request, the default is yesterday's date (current date - 1 day).

perPageinteger
Example:10

Number of entries per page. If the value is not sent in the request, the default value is 10.

pageinteger
Example:1

Page number of results to return. If the value is not sent in the request, the default value is 1.

Response

OK

pagesinteger

Total number of pages

current_pageinteger

Current page of the pagination

per_pageinteger

Amount of items that should be returned on each page

total_itemsinteger

Total amount of items available

Example response

{
  "pages": 3,
  "current_page": 1,
  "per_page": 1,
  "total_items": 3,
  "items": [
    {
      "account_id": 1234,
      "org_id": "08102A0B-D4F8-42A2-8B0E-2052D05577D7",
      "ref_date": "2022-01-02",
      "available_credit_limit": 1500.5,
      "available_total_installment_credit": 1000.3,
      "available_withdrawal_credit": 2000.6,
      "available_savings_account_limit": 2700.34,
      "held_funds": 10.34,
      "currency_code": "BRL",
      "currency_numeric_code": "986"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.