Simulate Account Closure

Overview

Test with dummy data

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

For credit card products, you have the option to close an account with a balance, which blocks authorizations and payment card issuance but allows repayments to continue to be made towards the outstanding balance payable.

You can subscribe to financial account attribute events to be notified when an account has been closed with a balance and financial account status events when the balance has been paid off and the account is CLOSED.

Simulate initiate an account closure

Initiating an account closure in the Test environment moves the financial account's status to PENDING_CLOSURE.

Use the following mutation to simulate initiating an account closure:

SimulateInitiateFinancialAccountClosure

Query

mutation simulateInitiateFinancialAccountClosure(
  $input: SimulateInitiateFinancialAccountClosureInput!
) {
  simulateInitiateFinancialAccountClosure(input: $input) {
    ... on FinancialAccount {
      __typename
      id
      accountStatus
      accountAttributes
    }
    ... on UserError {
      __typename
      errors {
        errorPath
        code
        description
      }
    }
    ... on AccessDeniedError {
      message
    }
  }
}

Variables

{
  "input": {
    "financialAccountId": "FINANCIAL_ACCOUNT_ID",
    "closeWithBalance": true
  }
}

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

Result

{
  "data": {
    "simulateInitiateFinancialAccountClosure": {
      "__typename": "FinancialAccount",
      "id": "ac_c02238648fd9693643adade6f55615b592e2",
      "accountStatus": "PENDING_CLOSURE",
      "accountAttributes": [
        "PENDING_CLOSURE",
        "CLOSED_WITH_BALANCE"
      ]
    }
  },
  "extensions": {
    "requestId": "REQUEST_ID"
  }
}

Simulate an account closure

In the Test environment, you can simulate account closure by moving the financial account from PENDING_CLOSURE to CLOSED.

Use the following mutation to simulate closing an account:

SimulateCloseFinancialAccount

Query

mutation simulateCloseFinancialAccount(
  $input: SimulateCloseFinancialAccountInput!
) {
  simulateCloseFinancialAccount(input: $input) {
    ... on FinancialAccount {
      __typename
      id
      accountStatus
      accountAttributes
    }
    ... on UserError {
      __typename
      errors {
        errorPath
        code
        description
      }
    }
    ... on AccessDeniedError {
      message
    }
  }
}

Variables

{
  "input": {
    "financialAccountId": "FINANCIAL_ACCOUNT_ID"
  }
}

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

Result

{
  "data": {
    "simulateCloseFinancialAccount": {
      "__typename": "FinancialAccount",
      "id": "FINANCIAL_ACCOUNT_ID",
      "accountStatus": "CLOSED",
      "accountAttributes": [
        "PENDING_CLOSURE"
      ]
    }
  },
  "extensions": {
    "requestId": "REQUEST_ID"
  }
}