Simulate Account Delinquency

Overview

test with dummy data

Do not enter production data in the Highnote Test environment, which is for exploring features and training. Use only dummy or test data.

The delinquency simulator lets you view a financial account's delinquency status and receivables by simulating past purchase and payment scenarios. In the Test environment, this helps with testing and configuring notification events.

The delinquency simulator allows you to test the following:

• View the financial account's delinquency status and balances by billing cycle for agent servicing, portfolio analysis, and collections strategies.
• Add the DELINQUENT and DELINQUENT_SUSPENDED financial account attributes when the financial account becomes delinquent and receive the associated notification events.
• Remove the DELINQUENT and DELINQUENT_SUSPENDED financial account attributes when the financial account becomes current and receive the associated notification events

Prerequisites

• A Highnote account
• API keys or the API Explorer
• A credit card product for your Test environment
• A new financial account for a credit card product
• No closed billing cycles on the financial account

Simulate delinquency

Use the following steps to simulate delinquency in your Test environment:

1. Issue a new financial account on an existing approved application and set the financial account's credit limit.
2. Issue a payment card to the financial account.
3. To create receivables, simulate and clear the desired authorizations, resulting in a simulated billing statement. The simulated billing statement should not include any pending authorizations.
4. Use the account aging simulation to generate a statement and age the financial account.
5. Optional - To clear the financial account's delinquency, make a payment for the past due amount.

Repeat steps 3 and 4 to generate additional past billing statements. If you simulate multiple billing statements, you must generate simulated billing statements from oldest to newest. For example, you must start by generating the oldest of the three to generate three billing statements.

Account aging simulation

info

To simulate multiple billing statements, you must generate simulated billing statements from oldest to newest. You cannot simulate the same past billing cycle more than once.

You can use the account aging simulation once you have simulated receivables and payments on a financial account. Refer to the following steps to use the account aging simulation:

1. To ensure your simulation results in a delinquent financial account, the OUTSTANDING_BALANCE_PAYABLE ledger must be greater than $0.
2. Provide the number of past billing cycles you want the simulated billing statement to generate. The simulator considers the unique calendar days of the financial account's due date, billing period start date, and billing period end date. For a list of simulation values, see Simulation values.

Note the following guidelines for using the account aging simulation:

• The financial account being simulated must be in its first billing cycle and cannot have a closed billing statement.
• We recommend issuing a new financial account each time you use the simulation.

Use the following mutation to simulate account aging:

SimulateBackwardShiftAndAgeCurrentFinancialAccountStatementPeriod

Query

mutation SimulateBackwardShiftAndAgeCurrentFinancialAccountStatement(
  $input: SimulateBackwardShiftAndAgeCurrentFinancialAccountStatementPeriodInput!
) {
  simulateBackwardShiftAndAgeCurrentFinancialAccountStatementPeriod(
    input: $input
  ) {
    __typename
    ... on FinancialAccount {
      id
      createdAt
      delinquency {
        __typename
        totalAmount {
          value
          currencyCode
        }
        numberOfCycles
        totalDaysDelinquent
        delinquencyStartedOn
        currentDelinquentCycles {
          daysDelinquent
          statement {
            periodStart
            periodEnd
            openedAt
            closedAt
            primaryLedger {
              debitBalance {
                value
              }
              creditBalance {
                value
              }
              normalBalance
            }
          }
          amount {
            value
            currencyCode
          }
          state
        }
      }
    }
    ... on UserError {
      errors {
        errorPath
        code
      }
    }
  }
}

Variables

{
  "input": {
    "financialAccountId": "FINANCIAL_ACCOUNT_ID",
    "numberOfCyclesToShiftCurrentStatementBackward": 3
  }
}

⚠️ Please login to execute queries. Visit the dashboard to authenticate.

Result

{
  "data": {
    "simulateBackwardShiftAndAgeCurrentFinancialAccountStatementPeriod": {
      "__typename": "FinancialAccount",
      "id": "FINANCIAL_ACCOUNT_ID",
      "createdAt": null,
      "accountStatus": null,
      "accountAttributes": null,
      "delinquency": {
        "__typename": "CreditPayInFullFinancialAccountDelinquency",
        "totalAmount": {
          "value": 200,
          "currencyCode": "USD"
        },
        "numberOfCycles": 2,
        "totalDaysDelinquent": 57,
        "delinquencyStartedOn": "2022-11-08T05:00:00.000Z",
        "currentDelinquentCycles": [
          {
            "daysDelinquent": 57,
            "statement": {
              "periodStart": "2022-10-04T05:00:00.000Z",
              "periodEnd": "2022-11-04T05:00:00.000Z",
              "openedAt": "2023-01-04T18:46:25.912Z",
              "closedAt": "2023-01-04T18:56:01.157Z",
              "primaryLedger": {
                "debitBalance": {
                  "value": 0
                },
                "creditBalance": {
                  "value": 200
                },
                "normalBalance": "CREDIT"
              }
            },
            "amount": null,
            "state": "DELINQUENT"
          },
          {
            "daysDelinquent": 27,
            "statement": {
              "periodStart": "2022-11-04T05:00:00.000Z",
              "periodEnd": "2022-12-04T05:00:00.000Z",
              "openedAt": "2023-01-04T18:56:01.157Z",
              "closedAt": "2023-01-04T18:59:07.703Z",
              "primaryLedger": {
                "debitBalance": {
                  "value": 0
                },
                "creditBalance": {
                  "value": 200
                },
                "normalBalance": "CREDIT"
              }
            },
            "amount": null,
            "state": "DELINQUENT"
          }
        ]
      }
    }
  },
  "extensions": {
    "requestId": "REQUEST_ID"
  }
}

Simulation values

Use the following simulation actions for the account aging simulation:

Attribute	Action
Add DELINQUENT	Shift the current billing cycle with a positive OUTSTANDING_BALANCE_PAYABLE back two or more cycles.
Add DELINQUENT_SUSPENDED	Shift the current billing cycle with a positive OUTSTANDING_BALANCE_PAYABLE back five or more cycles.
Remove DELINQUENT and DELINQUENT_SUSPENDED	Make the account current by posting a payment greater than or equal to the OUTSTANDING_BALANCE_PAYABLE.

Simulate repayment

info

Repayments may take up to five minutes to update a financial account's delinquency status.

You can simulate a repayment if your simulation results in a delinquent financial account. See Schedule Repayments for more information on simulating repayment.

Simulate charge off

info

In the Live environment, the Highnote team will close an account with a SUSPENDED status due to a charge-off event.

You can use the delinquency simulator in the Test environment to simulate a charge-off. Use the steps outlined in the Simulate Delinquency guide. In Step 4, shift an unpaid statement balance due back at least seven billing cycles to make the financial account's totalDaysDelinquent >= 180 days.

With the totalDaysDelinquent set to 180 days the financial account attribute of CHARGE_OFF will be added and the financial account status will be set to SUSPENDED.