Showing Credit Account data

Present Credit Account information to your customers

This is a brief guide on using credit account data to create account summary views for your secured charge card customers.

Credit Accounts

The following example illustrates the basic structure of a credit account:

{
    "account_id": "8a543f24-90af-420e-be48-c3e651d8332b",
    "program_id": "e618458e-f4bd-4870-9244-d7e062794e58",
    "customer_id": "6ad049b3-108e-4a35-b743-0a875542dbb6",
    "date_updated": "2022-09-06T21:36:26.376769Z",
    "date_created": "2022-07-01T15:59:13.924400Z",
    "type": "credit",
    "status": "active",
    "routing_number": "084106768",
    "account_number": "9501118375993606",
    "cards": [
        "4da1f1ff-95c4-412b-9dd1-8addb4dc6c99"
    ],
    "balance": {
        "current_balance": -500,
        "available_balance": -1700,
        "previous_statement_balance": 0,
        "locked_balance": 0,
        "currency": "USD"
    },
    "credit": {
        "credit_limit": 15242,
        "security_deposit_account_id": "d574e241-3745-493f-a784-8e3108cec5d7"
    },
    "description": ""
}

Useful Fields

The table below defines a few of the key fields you will use to display account information to customers with secured charge cards:

Field

Description

balance.current_balance

The amount the cardholder owes on their account, minus any pending purchases or payments. This is typically a negative value, and will differ from balance.available_balance when there are pending transactions.

balance.available_balance

The amount the cardholder owes on their account, including any pending purchases or payments. This is typically a negative value.

balance.previous_statement_balance

The balance owed on the statement for the previous billing cycle.

credit.credit_limit

The balance of the security deposit account linked to this credit account.

credit.security_deposit_account_id

The account_id of the security deposit account linked to this credit account.

When displaying these in an account summary, you can simply access the fields directly from the credit account object.

Calculating Available to Spend

One useful piece of information to present is the amount that is available to spend on the secured charge card. To calculate this, add the values for balance.available_balance and credit.credit_limit.

When a new credit account is created alongside a new secured charge card, the available_balance and current_balance both start at 0. As the customer makes more purchases, available_balance and current_balance take on greater negative values as they increase.

By adding the available_balance to the credit_limit, you will get the amount of available credit that the customer has left to use.

👍

Available to Spend

available_to_spend = balance.available_balance + credit.credit_limit


Did this page help you?