Testing the API

Before you start

The Highnote Test environment (or dashboard) replicates the full functionality of the Live environment, and lets you simulate real-time transactions and compliance scenarios.

The Highnote docs include an API Explorer (standalone and embedded as snippets) that lets you run those simulations (in the dashboard) from the docs. This guide explains how to use the API Explorer.

How It works

The API Explorer can be used in two ways:

• Highnote API Explorer: The Highnote API Explorer is an interface for executing API calls in your Test environment, perform queries, and search the Highnote API schema. You can write your own queries and mutations, or start from any example in these docs.

• Embedded code snippets: Highnote embeds instances of the API Explorer directly in the Highnote documentation. These instances appear as testable code snippets. You can use the sample query supplied in each instance of the built-in tool to send requests to the Highnote API executed in your Test environment.

Using embedded code snippets

To use the embedded code snippets, you must sign in to your Highnote account. Once signed in, the embedded code snippets communicate with your Test environment.

To execute an embedded code snippet in the Highnote docs:

1. Go to any page with a executable code snippet, e.g., Simulate External Wire Transfer.
2. Review the mutation in the Operation window of the embedded API Explorer. You do not need to change anything in this section for testing purposes.
3. Click Variables to open the input variables section. You can either use the pre-filled inputs or customize them for testing purposes.
4. Click Run Query to execute the request in your Test environment. The Response section populates the request response.
5. Open your Highnote dashboard and verify that the request was executed correctly in your Test environment. If you use the default values, "My Test Product" will be listed as a Commercial Prepaid product in your dashboard.

Using the Highnote API Explorer

To use the Highnote API Explorer, you must sign in to your Highnote dashboard.

Running an operation

To run an operation in the API Explorer:

1. Open the API Explorer and enter a query or mutation in the Operation window.

   To start from a worked example instead of writing one from scratch, use the executable snippet on any guide in these docs — for example Simulate External Wire Transfer — and copy it across.

2. Click Variables to open the input variables section, and supply any variables your operation takes.

3. Click Run Query or Run Mutation to execute the API call.

   The response populates in the Response field. You can also verify the API call was executed correctly in the dashboard.

Use the Docs tab to browse the Highnote schema while you work, and the History tab to return to operations you have already run in this browser.

Using autocomplete

The API Explorer has an autocomplete feature that populates options based on what is in the Highnote schema. You can use the autocomplete feature to help you build your queries and mutations.

To build a simple query with autocomplete:

1. Open the API Explorer. Clear the Query window if pre-populated.

2. Start typing qu and choose query from the autocomplete box.

3. Append curly brackets, e.g., query{ }, then inside the brackets, type re and select reportUsage to create the query, query{reportUsage}.

   The query shows an error with a red wavy line under reportUsage.

4. Hover over reportUsage to reveal an error message above and a link to the schema docs just below.

5. While hovering, click the blue reportUsage hyperlink under {reportUsage} to expose the schema docs on the right.

6. In the Schema window, click ReportUsage! to expose valid subfields and their descriptions.

7. Leaving the error as is, click Run Query in the Variables window.

   Two things happen: (a) The Query window populates with all valid subfields and the error clears. (b) The Results window returns a paginated list of reports with usage limits from your Test environment.

Operation

query {
  reportUsage {
    reportType
    limit
    limitRemaining
    periodEnd
  }
}

Response

{
  "data": {
    "reportUsage": [
      {
        "reportType": "CARD_TRANSACTION_ACTIVITY",
        "limit": 3,
        "limitRemaining": 3,
        "periodEnd": "2025-01-15T05:00:00.000Z"
      },
      {
        "reportType": "LEDGER_ENTRY",
        "limit": 3,
        "limitRemaining": 3,
        "periodEnd": "2025-01-15T05:00:00.000Z"
      },
      ...
    ]
  },
  "extensions": {
    "requestId": "8d8389b4-9755-98a6-b72b-dac56a3d84ec",
    "rateLimit": {
      "cost": 1,
      "limit": 100000,
      "remaining": 99999
    }
  }
}