Skip to main content

17 docs tagged with "API"

View all tags

About Developer Resources

Learn about the Highnote GraphQL API, client-side SDKs, event notifications, and Snowflake Data Share for analytics.

API Error Handling

Handle GraphQL errors using the errors-as-data pattern with UserError types. Use the requestId field to troubleshoot failed requests with Highnote support.

API Rate Limiting

Manage request count and complexity rate limits, implement exponential backoff for 429 responses, and use webhooks to reduce polling.

API Status and Changes

Monitor the operational status of the Highnote platform and GraphQL API, subscribe to incident notifications, and track GraphQL schema changes programmatically.

Custom Fields for Metadata

Add, update, and query custom key-value metadata on financial accounts and payment cards to link external system IDs, tag objects, and filter searches.

Entity IDs and Object Types

How Highnote entity IDs work, how to identify object types using the __typename field, and how to read the placeholder IDs used throughout the documentation.

Events Reference

Look up event notification types by domain with their corresponding API objects.

Fetching Events

Fetch, monitor, and replay notification events. Events are stored for 30 days and can be filtered by type, status, and date.

Highnote Query Language

Search for accounts, cards, transactions, and other objects using Highnote Query Language (HQL).

Idempotency

Prevent duplicate mutations when retrying failed API requests by providing unique idempotency keys with your requests.

Intro to GraphQL

Learn core GraphQL concepts including queries, mutations, the type system, and Relay pagination as they apply to the Highnote API.

Notifications

Set up webhook and email notifications to monitor and respond to events in your integration.

Request Complexity

Calculate the computational cost of your GraphQL queries and optimize them to stay within complexity limits.

Rotating API Keys

Rotate your API keys to maintain security. Create new keys, update your applications, and revoke old keys through the Highnote Dashboard.

Searching the API

Search and filter API objects using date, number, string, and enum filters. Combine multiple filters and understand search latency and data retention limits.

Testing the API

Simulate real-time transactions and compliance scenarios in the Highnote Test environment before going live.

Using the Highnote API

Make GraphQL requests to the Highnote API with proper authentication headers, request body structure, and response handling.