PIpismo
Delinquency

List delinquency buckets

Get an account's delinquency buckets with filtering options. For more information, see the Delinquency buckets guide.

NOTE: This endpoint requires an account token — an access token encoded with an account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

get/v1/accounts/{accountId}/buckets

Request

  • Base URL
    https://sandbox.pismolabs.io/delinquency-bucket-api
  • URL
    https://sandbox.pismolabs.io/delinquency-bucket-api/v1/accounts/{accountId}/buckets
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:18899

Account ID

Query parameters

pageinteger
Example:1

Current page

perPageinteger
Example:10

Items per page. Default is 10.

hasDelinquencyBalanceboolean
Example:true

false = return all account's existing delinquency buckets. true = return only delinquency bucket with balance amount greater than zero. Default is false.

allBucketsboolean
Example:true

true = return all buckets. false = return all buckets with DueDate less than today (or DueDate null for legacy buckets). Default is false.

Response

Ok

current_pageinteger

Current page

per_pageinteger

Number of elements, default is 10

total_itemsinteger

Total elements found for the request

items_on_pageinteger

Total elements on this page

pagesinteger

Total pages for the request

is_last_pageboolean

Is the current page the last page flag

Example response

{
  "items": [
    {
      "statement_id": 847490277,
      "cycle_closing_date": "2024-01-02T00:00:00.000Z",
      "due_date": "2024-01-02T00:00:00.000Z",
      "statement_cycle": 1,
      "delinquencyBucket_id": 21,
      "calculation_memory": {
        "strategy": "DEFAULT",
        "mad": 52.5
      },
      "overdue_amount": 87,
      "unexpired_bucket": true,
      "bucket_amount": 87,
      "bucket_balance": 99,
      "created_at": "2022-11-09T18:57:49.000Z",
      "updated_at": "2022-11-09T18:57:49.000Z"
    }
  ],
  "current_page": 1,
  "per_page": 10,
  "total_items": 100,
  "items_on_page": 5,
  "pages": 1,
  "is_last_page": true
}

Changes

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