API Status and Changes

Idempotency

Highnote API

The Highnote API lets you add "global notes" to any primary and aggregate entity. Global notes are encrypted at rest. Currently, the following primary entities support global notes:

- `AccountHolderCardProductApplication`
- `FinancialAccount`


Overview

Use the `createGlobalNote` mutation to annotate Highnote entities.

~~~graphql
mutation createGlobalNote($input: CreateGlobalNoteInput!) {
  createGlobalNote(input: $input) {
    __typename
    ... on GlobalNote {
      id
      createdBy {
        id
        email
      }
      message
      createdAt
      primaryEntity {
        __typename
        ... on FinancialAccount {
          id
          externalId
        }
      }
      aggregateEntity {
        __typename
        ... on USBusinessAccountHolder {
          id
          externalId
        }
        ... on USPersonAccountHolder {
          id
          externalId
        }
      }
    }
    ... on AccessDeniedError {
      message
    }
    ... on UserError {
      errors {
        __typename
        errorPath
        code
        description
      }
    }
  }
}
~~~

~~~json
{
	"data": {
		"createGlobalNote": {
			"__typename": "GlobalNote",
			"id": "agsno_c75eba94fad24658b5adefecaa08b319",
			"createdBy": {
				"id": "ps_pr01bf5b7b4980fseed792a78c185b3603ab",
			},
			"message": "My cool note",
			"createdAt": "2024-06-09T00:55:57.385Z",
			"primaryEntity": {
				"__typename": "FinancialAccount",
				"id": "ac_c022313f71c8f3fb40e8a1ed5e934a06c176",
				"externalId": "4AU2NQN6T8"
			},
			"aggregateEntity": {
				"__typename": "USBusinessAccountHolder",
				"id": "og_ah0268cbcecc8d8e452db5bf52c811ed9b9a",
				"externalId": "bluejay"
			}
		}
	},
	"extensions": {
		"requestId": "8a0d3e02-0dfd-9f97-bf59-495069882f75"
	}
}
~~~

createGlobalNote

Create global note

Use the following query to look up notes on a financial account:

~~~graphql
query findAccountHolderWithNotes($id: ID!, $notesFirst: Int = 2) {
	node(id: $id) {
		__typename
		... on USPersonAccountHolder {
			id
			email
			globalNotes(first: $notesFirst) {
				__typename
				... on GlobalNoteConnection {
					pageInfo {
						hasNextPage
						hasPreviousPage
						startCursor
						endCursor
					}
					edges {
						cursor
						node {
							__typename
							... on GlobalNote {
								id
								createdBy {
									id
								}
								message
								createdAt
								primaryEntity {
									__typename
								}
								aggregateEntity {
									__typename
								}
							}
						}
					}
				}
			}
		}
		... on USBusinessAccountHolder {
			id
			externalId
			globalNotes(first: $notesFirst) {
				__typename
				... on GlobalNoteConnection {
					pageInfo {
						hasNextPage
						hasPreviousPage
						startCursor
						endCursor
					}
					edges {
						cursor
						node {
							__typename
							... on GlobalNote {
								id
								createdBy {
									id
								}
								message
								createdAt
								primaryEntity {
									__typename
								}
								aggregateEntity {
									__typename
								}
							}
						}
					}
				}
			}
		}
	}
}
~~~

~~~json
{
	"data": {
		"node": {
			"__typename": "USBusinessAccountHolder",
			"id": "og_ah0268cbcecc8d8e452db5bf52c811ed9b9a",
			"externalId": "test",
			"agentNotes": {
				"__typename": "GlobalNoteConnection",
				"pageInfo": {
					"hasNextPage": true,
					"hasPreviousPage": false,
					"startCursor": "dD0yMDIzLTA2LTA5VDAwJTNBNTUlM0E1Ny4zODUwMDAwMDBaJmk9YWdzbm9fYzc1ZWJhOTRmYWQyNDY1OGI1YWRlZmVjYWEwOGIzMTk",
					"endCursor": "dD0yMDIzLTA2LTA5VDAwJTNBNTUlM0EyOC4yMzcwMDAwMDBaJmk9YWdzbm9fYWI0NzFiYjFkOWYwNGZmMTk2ZjdmYzU3MjE3NTQ0NmI"
				},
				"edges": [
					{
						"cursor": "dD0yMDIzLTA2LTA5VDAwJTNBNTUlM0E1Ny4zODUwMDAwMDBaJmk9YWdzbm9fYzc1ZWJhOTRmYWQyNDY1OGI1YWRlZmVjYWEwOGIzMTk",
						"node": {
							"__typename": "GlobalNote",
							"id": "agsno_c75eba94fad24658b5adefecaa08b319",
							"createdBy": {
								"id": "ps_pr01bf5b7b4980fseed792a78c185b3603ab",
							},
							"message": "My super note",
							"createdAt": "2023-06-09T00:55:57.385Z",
							"primaryEntity": {
								"__typename": "FinancialAccount"
							},
							"aggregateEntity": {
								"__typename": "USBusinessAccountHolder"
							}
						}
					},
					{
						"cursor": "dD0yMDIzLTA2LTA5VDAwJTNBNTUlM0EyOC4yMzcwMDAwMDBaJmk9YWdzbm9fYWI0NzFiYjFkOWYwNGZmMTk2ZjdmYzU3MjE3NTQ0NmI",
						"node": {
							"__typename": "GlobalNote",
							"id": "agsno_ab471bb1d9f04ff196f7fc572175446b",
							"createdBy": {
								"id": "ps_pr01bf5b7b4980fseed792a78c185b3603ab",
							},
							"message": "My super cool note",
							"createdAt": "2023-06-09T00:55:28.237Z",
							"primaryEntity": {
								"__typename": "FinancialAccount"
							},
							"aggregateEntity": {
								"__typename": "USBusinessAccountHolder"
							}
						}
					}
				]
			}
		}
	},
	"extensions": {
		"requestId": "7a5641b4-9185-971a-874c-43e5d5241c88"
	}
}
~~~

findAccountHolderWithNotes

Query financial account notes

Use the following query to look up notes on an account holder's card product application:

~~~graphql
query GetAccountHolderCardProductApplication($id: ID!) {
	node(id: $id) {
		... on AccountHolderCardProductApplication {
			id
			applicationState {
				status
			}
			globalNotes {
				... on GlobalNoteConnection {
					edges {
						node {
							primaryEntity {
								__typename
								... on AccountHolderCardProductApplication {
									id
								}
							}
							createdBy {
								... on User {
									id
									email
									roles
									clientCredentials {
										organization {
											id
										}
									}
								}
							}
							createdAt
							message
						}
					}
				}
			}
			updatedAt
			createdAt
		}
	}
}


~~~

~~~json
{
  "data": {
    "node": {
      "id": "ap_22pcgma9eb0efe9ecd4bb68216c6905a3bdf02",
      "applicationState": {
        "status": "APPROVED"
      },
      "globalNotes": {
        "edges": [
          {
            "node": {
              "primaryEntity": {
                "__typename": "AccountHolderCardProductApplication",
                "id": "ap_22pcgma9eb0efe9ecd4bb68216c6905a3bdf02"
              },
              "createdBy": {
                "id": "ps_pr01bf5b7b4980fseed792a78c185b3603ab"
              },
              "createdAt": "2025-02-14T18:25:59.684Z",
              "message": "Fraud note test"
            }
          }
        ]
      },
      "updatedAt": "2025-02-14T18:26:01.151Z",
      "createdAt": "2025-02-14T18:24:00.990Z"
    }
  },
  "extensions": {
    "requestId": "6fee3d68-2b1b-94e3-8b85-b65a69f2bc5d"
  }
}
~~~

GetAccountHolderCardProductApplication

Query card product application notes

Global Notes

Issue Your First Card

Test Your Integration

Using Ledgers

Controlling Authorizations with Spend Rules

Order Physical Cards

Managing Financial Accounts

Transactions

Issuing

Funds Movement

Search & Filters

Events and Notifications

Ledgers

Get Started

Quick Start Templates

Dashboard

Issue Cards

Control Authorizations

Move Money

Handle Transactions

Manage Credit

Onboard Accounts

Compliance

Card Design

Test the API

Generate Reports

Accept Payments

Simulate Payments

Offer Rewards

Build a Transaction Feed

Issuing SDKs

Acquiring SDKs

Data Sharing

Onboard Subscribers

Payment Orders

United Funds Transfers

Unified Vault

Changelog (Internal)

Highnote Overview

PCI Data Security Standards

Intro to GraphQL

Using the Highnote API

Rotate API Keys

API Rate Limiting

Request Complexity

API Error Handling

Search

Universal Transaction Search

Highnote Query Language

Custom Fields

Using the Dashboard

Notifications

Events

Events Reference

Launch Checklist

Basics

Issuing Overview

Virtual Cards

Physical Cards

Digital Wallets

Design Your Card Experience

Marketing and Collateral

Cards in Marketing

Co-Brands

Onboard an Account

Request Documents for Application Review

Onboard Authorized Users

Update Account Information

Close an Account

Financial Account Revisions

Simulate Application Review

Simulate Account Closure

Manage Card Profiles

Print Physical Cards

Print Physical Cards in Bulk

Issue Preprinted Physical Cards

Display Card and Account Details

Manage Cards

Payment Card Revisions

Add Cards to Digital Wallets

Simulate Card Order Fulfillment

Simulate Address Validation

Simulate Digital Wallet Token Provisioning

Transaction Lifecycle

Common Transaction Scenarios

Common Fleet Transaction Scenarios

Fees

Chargebacks and Disputes

Simulate Transactions

Simulate Fleet Transactions

Configure Spend Rules

Configure Velocity Controls

Collaborative Authorization

Collaborative Authorization Fleet Data

Suspend an Account

Simulate Collaborative Authorization

Add Funds to your Balance

ACH Fund Transfers

Connect External Accounts

Add Funds to an Account

Transfer between Financial Accounts

Move Funds Out of Highnote

On-demand Funding

Payroll Advance

Check Payment

Simulate Connecting an External Account

Simulate a Wire Transfer

Simulate ACH Transfers

Credit Overview

Standard Credit Purchase

BNPL and Flexible Installments

Find Variable Interest Rates

Simulate Underwriting Decision

Collaborative Application Decisioning

Set and Update Credit Limits

Deliver Statements

Schedule Repayments

Credit Bureau Reporting

Account Delinquency

Create Secured Deposit Offer

SCRA and MLA

Simulate Billing Statements

Simulate Delinquency

Simulate Repayments

Create Reward Earn Rule

Configure Reward Redemption

Redeem Rewards

Adjust and Find Rewards

Using Reports

Card Interchange Activity Report

Card Transaction Activity Report

Credit Loan Tape Report

Fleet Enhanced Data Summary Report

Ledger Entry Report

Negative Account Balance Report

Receivable Sale Reports

Summary Metrics

Data Schema

Commercial Credit

Consumer Credit

Commercial Charge

Consumer Charge

Fleet

AP Automation

Commercial Prepaid

Consumer Prepaid

SDK Overview

Client Tokens

Installation

Supported Packages and Browsers

Card Viewer SDK

Document Upload SDK

Risk Application SDK

Sardine Processor API

Secure Inputs SDK for PINs

Checkout SDK

Secure Inputs SDK for Tokenization

SDKs

Acquiring Overview

Online Payments

Simulate Authorizations and Declines

Display Transactions

Acquiring

Highnote Platform Overview

Instant Network Transfers

Concepts

Platform