Delinquency

Get delinquency bucket

Get account delinquency bucket given an account ID and bucket ID in the path. You can get delinquency bucket IDs from the List delinquency buckets endpoint. You can use delinquency buckets to control and manage cardholder delinquency. Buckets are created at cycle close. 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/{delinquencyBucketId}

Request

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

Path parameters

accountIdinteger required
Example:18898

Account ID

delinquencyBucketIdinteger required
Example:1

Delinquency bucket ID. You can get delinquency bucket IDs from the List delinquency buckets endpoint.

Response

Ok

statement_idinteger

Statement ID

cycle_closing_datestring

Cycle closing date

due_datestring

Due date

statement_cycleinteger

Statement cycle

delinquencyBucket_idinteger

Delinquency bucket ID

overdue_amountnumber

Overdue amount

unexpired_bucketboolean

Informs if the bucket is unexpired

bucket_amountnumber

Bucket amount

bucket_balancenumber

Bucket balance

created_atstring date-time

Bucket creation date in ISO-8601 UTC time

updated_atstring date-time

Bucket last updated date in ISO-8601 UTC time

Example response

{
  "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"
}

Changes

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