Payments Entrypoints

Entrypoints are the links available on the API root resource. They are the starting points for every payments flow. You discover them by making a GET request to the root URL.

Root

The only URL you need to hardcode. Everything else is discovered from its response.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/
Demo	https://api-platform.demo.flywire.com/agents/v2/

curl

curl 'https://api-platform.demo.flywire.com/agents/v2/' \
  --header 'X-Authentication-Key: YOUR_API_TOKEN'

Python

import requests

response = requests.get(
    "https://api-platform.demo.flywire.com/agents/v2/",
    headers={"X-Authentication-Key": "YOUR_API_TOKEN"}
)
root = response.json()

Node.js

const response = await fetch(
  "https://api-platform.demo.flywire.com/agents/v2/",
  { headers: { "X-Authentication-Key": "YOUR_API_TOKEN" } }
);
const root = await response.json();

Available Entrypoints

The root response contains links to these payment-related resources:

payment-recipients

Browse the tree of payment destinations and create payment experiences.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/grouped-payment-recipients
Demo	https://api-platform.demo.flywire.com/agents/v2/grouped-payment-recipients

Full relation: tag:flywire.com,2016:agents:api:relation:payment-recipients

intermediated-payments

List all payments intermediated by your agency.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/intermediated-payments
Demo	https://api-platform.demo.flywire.com/agents/v2/intermediated-payments

Full relation: tag:flywire.com,2016:agents:api:relation:intermediated-payments

claim-intermediation-of-payment

Claim an existing payment as intermediated by your agency.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/payment-intermediation-claim
Demo	https://api-platform.demo.flywire.com/agents/v2/payment-intermediation-claim

Full relation: tag:flywire.com,2016:agents:api:relation:claim-intermediation-of-payment

Reference

• Payments Relations — formal definition of the entrypoint relations above
• Payments Profiles — the response shapes you will encounter
• Payments Schemas — the JSON Schemas of the response bodies