API overview

The Fluz API is a single GraphQL endpoint per environment. This page is the reference companion to How the GraphQL API works.

Browse the reference

Queries

Read operations — fetch wallets, transactions, merchants, card offers, and account data.

Mutations

Write operations — issue cards, move money, register users and businesses, and manage approvals.

Types

Objects

Response shapes returned by queries and mutations.

Input objects

Arguments you pass to operations.

Enums

Fixed sets of allowed values, like statuses and card networks.

Unions

Fields that resolve to one of several object types.

Interfaces

Shared field contracts implemented by multiple objects.

Scalars

Primitive values like DateTime and UUID.

Conventions

Authentication

The Authorization header, token endpoints, and the OAuth authorization redirect.

Errors

The error envelope, domain code prefixes, and retry guidance.

Rate limits

Per-surface request limits and what a 429 looks like.

Pagination

Offset inputs, page-size caps, and connection responses.

REST endpoints

One operation lives outside GraphQL — the file upload used for sole proprietorship registration.

Endpoints

Environment	GraphQL endpoint
Staging	`https://transactional-graph.staging.fluzapp.com/api/v1/graphql`
Live	`https://transactional-graph.fluzapp.com/api/v1/graphql`

Access tokens are minted at the same endpoint via the generateUserAccessToken mutation, authorized with your API Key — see Authentication.

Headers

Header	Required	Notes
`Authorization`	Yes	`Bearer <access_token>` (`Basic <API_KEY>` when calling `generateUserAccessToken`)
`Content-Type`	Yes	`application/json`

Response envelope

{
  "data": { ... },
  "errors": [ ... ]
}

data — the successful payload (may be partial on error).
errors — array of failures, each with code, message, and path.

Schema

Staging exposes introspection so you can point tooling (Apollo Studio, GraphiQL, codegen) at it directly. In live, request the current SDL from your account team.

​Browse the reference