PIpismo
Statement

Get account total due

Get the total amount due for an account.

get/statements-v2/v2/accounts/{accountId}/total-due

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v2/accounts/{accountId}/total-due
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Response

Ok

account_idinteger

Account ID

current_cycleinteger

Current cycle

open_due_datestring date

Open due date. Format = yyyy-mm-dd.

collection_status'NORMAL' | 'OVERDUE'

Collection status:

  • NORMAL
  • OVERDUE

If a customer fails to pay at least the minimum amount due on their credit account by a specified number of days after the due date, the account's collection_status is set to OVERDUE. In all other cases, it should be NORMAL. For more information, refer to Credit liquidation.

Example response

{
  "account_id": 1010,
  "current_cycle": 5,
  "open_due_date": "2021-05-24",
  "collection_status": "OVERDUE",
  "balance": {
    "closed_due": 150,
    "open": 150,
    "future": 200
  },
  "pending_accruals": [
    {
      "accrual_type": "REFINANCING",
      "amount": 2.5
    }
  ]
}

Changes

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