Get Account Dashboard

Use the Get Account Dashboard API endpoint to retrieve a consolidated view of account balances, limits, and status for a customer's line of credit account.

📘
Early Access
Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Get Account Dashboard endpoint enables you to retrieve a consolidated view of account balances, limits, and status for a customer's line of credit account. This forms the primary data source for building account dashboard experiences within your own user interface.

📘
More Information
For more information about the Explorer endpoints, see: Credit Explorer.

Example Request

Retrieve account dashboard information by making a GET request to the Get Account Dashboard endpoint.

GET {{baseUrl}}/api/v1/credit/explorer/accounts/{account_id}/dashboard

Path Parameters

Parameter	Description
`account_id`	string. Required. The unique identifier of the account.

Example Response

A successful request returns a 200 HTTP status code with the account dashboard information.

{
  "uuid": "12345",
  "customerId": "67890",
  "clientAssignedId": "client_acc_001",
  "clientAssignedCustomerId": "client_cust_001",
  "productId": "1",
  "productDescription": "Standard Credit Card",
  "accountStatus": "ACTIVE",
  "assetCurrency": "USD",
  "creditLimit": "5000.00",
  "balance": "1200.00",
  "pendingBalance": "50.00",
  "availableCredit": "3750.00",
  "totalDue": "1200.00",
  "minimumDue": "25.00",
  "dueDate": "2025-02-15",
  "amountPastDue": "0.00",
  "amountOverLimit": "0.00",
  "daysPastDue": "0",
  "nextStatementDate": "2025-02-01",
  "bucketsInfo": [
    {
      "name": "Purchases",
      "balance": "1000.00",
      "availableCredit": "4000.00",
      "interestRate": "19.99",
      "creditLimit": "5000.00"
    },
    {
      "name": "Cash Advances",
      "balance": "200.00",
      "availableCredit": "800.00",
      "interestRate": "24.99",
      "creditLimit": "1000.00"
    }
  ]
}

Response Fields

Account Object

Attribute	Description
`uuid`	string or null. The internal identifier of the account.
`customerId`	string or null. The internal identifier of the customer associated with the account.
`clientAssignedId`	string or null. The identifier assigned to the line of credit account in the loan management system.
`clientAssignedCustomerId`	string or null. The identifier assigned to the customer in the loan management system.
`productId`	string or null. The identifier of the credit product associated with the account.
`productDescription`	string or null. A description of the credit product associated with the account.
`accountStatus`	string or null. The current status of the account.
`assetCurrency`	string. The currency of the account. Default is `USD`.
`creditLimit`	string. The total credit limit of the account.
`balance`	string. The current balance of the account.
`pendingBalance`	string. The pending balance of the account, including transactions that have not yet settled.
`availableCredit`	string. The amount of credit currently available for purchases.
`totalDue`	string. The total amount due on the account.
`minimumDue`	string. The minimum payment amount due.
`dueDate`	string or null. The date by which the minimum payment must be made.
`amountPastDue`	string. The amount that is past due on the account.
`amountOverLimit`	string. The amount by which the account balance exceeds the credit limit.
`daysPastDue`	string or null. The number of days the account is past due.
`nextStatementDate`	string or null. The date on which the next billing statement will be generated.
`bucketsInfo`	array. A list of credit buckets associated with the account. See Bucket Object.

📘
Note
Cash advance balance, available credit, and limit are reported per bucket rather than as separate top-level fields — see the Cash Advances entry in bucketsInfo below.

Bucket Object

Attribute	Description
`name`	string. The name of the credit bucket. Possible values: `Purchases`, `Cash Advances`.
`balance`	string. The current balance of the bucket.
`availableCredit`	string. The amount of credit available in the bucket.
`interestRate`	string. The interest rate applied to the bucket.
`creditLimit`	string. The credit limit of the bucket.

Updated 4 days ago

Did this page help you?