Agents API Docs

Appearance

Agents APIPayments & Insurance

Programmatically intermediate payments and insurance applications for your clients through a Hypermedia-driven REST API.

Getting Started
Reference
Payments API
Insurance API

Hypermedia-Driven

Navigate the API by following links in responses — no hardcoded URLs. The API tells you what you can do next at every step.

Reference

The authoritative catalogue of relations, profiles, and JSON Schemas for both APIs. Look up any link, response shape, or status enum here.

Payments

Create payment experiences, track intermediated payments, and claim payment intermediation for your agency's clients.

Insurance

Apply for OSHC, OVHC, and NZ insurance policies — request quotes, compare offers, and manage applications.

Interactive Guides

Runnable guide applications in Python and Node.js that walk you through real API flows step by step.

How This API Works ​

The Agents API is a HATEOAS (Hypermedia as the Engine of Application State) API. Instead of memorizing endpoint URLs, you start at the root and follow links to navigate through available actions.

Every response contains a links array. Each link has a rel (relation type) that tells you what it does, and an href that tells you where to go. You never construct URLs yourself — you discover them.

New to HATEOAS?

Start with the Core Concepts section to understand how hypermedia-driven APIs work, then follow one of the step-by-step flow guides.

Reference ​

The Reference section is the authoritative catalogue of every relation, profile, and JSON Schema the API uses. Pick a domain and dive in:

DomainRelationsProfilesSchemas
Common — shared across both APIsRelationsProfilesSchemas
Payments — Payments-only extensionsRelationsProfilesSchemas
Insurance — Insurance-only extensionsRelationsProfilesSchemas

Where to look first

  • Need to know what a link rel means? → Relations.
  • Need to know what shape a response is? → Profiles.
  • Need the exact JSON Schema of a request or response body? → Schemas.

Flywire Agents API Documentation

© 2026 Flywire