Documentation Index Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt
Use this file to discover all available pages before exploring further.
eSIM API deprecation — All /esim/* endpoints will be removed on 2026-05-30 . Existing integrations must migrate before that date. See the eSIM section below for affected endpoints.This section provides detailed documentation for every V3 endpoint, including request/response schemas, parameters, and examples.
Base URL https://api.fyatu.com/api/v3
Authentication V3 uses JWT Bearer tokens. First obtain a token, then include it in all requests:
# Step 1: Get token curl -X POST https://api.fyatu.com/api/v3/auth/token \ -H "Content-Type: application/json" \ -d '{"appId": "YOUR_APP_ID", "secretKey": "YOUR_SECRET", "grantType": "client_credentials"}' # Step 2: Use token curl -X GET https://api.fyatu.com/api/v3/collections \ -H "Authorization: Bearer YOUR_JWT_TOKEN"
All requests use JSON body format
Set Content-Type: application/json for POST/PUT/PATCH requests
All timestamps are in ISO 8601 format
All V3 responses follow this structure:
Success (2xx)
Error (4xx/5xx)
{ "success" : true , "status" : 200 , "message" : "Operation completed successfully" , "data" : { ... }, "meta" : { "requestId" : "req_xxxxxxxxxxxx" , "timestamp" : "2026-01-05T10:30:00+00:00" } }
Available Endpoints Authentication Obtain and manage JWT access tokens.
Method Endpoint Description POST /auth/tokenGenerate access token POST /auth/refreshRefresh existing token POST /auth/revokeRevoke a token
Account Manage your business account, wallet, and fees.
Method Endpoint Description GET /account/pricingGet applicable fees GET /account/walletGet wallet balances GET /account/transactionsList account transactions GET /account/withdrawalsGet withdrawal history POST /account/deposit-addressGenerate deposit address POST /account/withdrawal-addressRegister withdrawal address
Collections Accept payments from customers.
Method Endpoint Description POST /collectionsCreate checkout session GET /collectionsList collections GET /collections/{id}Get collection details POST /collections/{id}/refundIssue a refund
Refunds Manage refunds for collections.
Method Endpoint Description GET /refundsList refunds
Payouts Send money to Fyatu account holders.
Method Endpoint Description GET /accounts/{clientId}Verify recipient account POST /payoutsCreate payout GET /payoutsList payouts GET /payouts/{id}Get payout details
eSIM Issue and manage travel eSIMs.
Method Endpoint Description GET /esim/destinationsList destinations GET /esim/destinations/{slug}Get destination with packages GET /esim/packagesList packages for a destination GET /esim/packages/{id}Get package details POST /esim/purchasePurchase an eSIM GET /esim/listList purchased eSIMs GET /esim/{id}Get eSIM details POST /esim/{id}/refreshRefresh eSIM usage GET /esim/{id}/topupsGet top-up packages POST /esim/{id}/topupTop-up existing eSIM
Error Codes Code HTTP Description AUTH_TOKEN_MISSING401 No token provided AUTH_TOKEN_INVALID401 Token is malformed or expired AUTH_TOKEN_EXPIRED401 Token has expired AUTH_INVALID_CREDENTIALS401 Invalid appId or secretKey AUTH_APP_INACTIVE401 App is not active AUTH_SCOPE_DENIED403 Token lacks required scope VALIDATION_ERROR400 Request validation failed RESOURCE_NOT_FOUND404 Resource not found INSUFFICIENT_BALANCE402 Wallet balance too low DUPLICATE_REFERENCE409 Reference already used RATE_LIMIT_EXCEEDED429 Too many requests INTERNAL_ERROR500 Server error
Rate Limits Endpoint Category Rate Limit Authentication 10 req/min Read operations 100 req/min Write operations 30 req/min
Exceeding rate limits returns 429 Too Many Requests. Implement exponential backoff in retry logic.
