API Basics

What the TransFi API does, how this reference is organized, and the one call to learn.

One API to move money across borders. Collect in 30+ countries, pay out to banks and wallets, hold many currencies, and move between local currency and stablecoin.

How this reference is organized

SectionWhat is in itRead it when
🚀 Getting ReadyThese basics, and the lookups you make first: MIDs, currencies, tokens, payment methods, limitsBefore your first call
👥 PeopleSenders, recipients, roles, KYC, KYB and verification linksRegistering whoever pays or gets paid
💸 PaymentsRates, orders, documents, Scan Pay, balances, virtual accounts and settlementsMoving money. Every flow starts at Create Order
🧪 SandboxSimulation endpoints that exist only in sandboxTesting

Webhook events, with every status and what to do about it, are in the guides under Webhooks.

One call to learn

Every payment is POST /v3/orders. The orderType picks the flow:

orderTypeWhat it does
payinA customer pays you
gamingA customer pays you through a custodial wallet created in their name
payoutYou pay a person or a business
onramp / offrampYour user buys or sells crypto
fiat_prefund / crypto_prefundYou add your own money to your balance
swapYou convert a balance you hold into another currency

The flow guides show each one end to end. This reference specifies every field.

What every endpoint page gives you

What it does and when to call it · every parameter, with enum values explained · one runnable example · every response and what to do about it · links to the guide that uses it.

In this section

Authentication & Headers · Environments · Idempotency · Pagination · Rate Limits · Errors · API Version · Glossary · Enums · Build with AI