API v2 is deprecated. This version will be discontinued on December 31, 2026. Please migrate to API v3 for new features, improved security, and continued support. API Reference
Welcome to the FYATU API reference. This section provides detailed documentation for every endpoint, including request/response schemas, parameters, and examples.
Base URL
All API requests should be made to:
https://api.fyatu.com/api/v2
Authentication
Every request requires two headers:
Business-ID: BUS_your_business_id
Authorization: Bearer sk_live_your_api_key
Getting Your API Credentials
- Login to your FYATU account
- Go to Business Console
- Click on your Issuing App
- Navigate to Settings → API Keys & Credentials tab
See the Authentication guide for more details.
- All requests should use JSON body format
- Set
Content-Type: application/json for POST/PUT/PATCH requests
- All timestamps are in ISO 8601 format
All responses follow this structure:
{
"status": "success",
"statusCode": 200,
"errors": false,
"message": "Operation completed successfully",
"data": { ... }
}
{
"status": "failed",
"statusCode": 400,
"errors": true,
"message": "Error description",
"data": []
}
Available Endpoints
Account
Manage your business account and wallet.
| Method | Endpoint | Description |
|---|
| GET | /account/status | Get account information |
| GET | /account/balance | Get wallet balance |
| GET | /account/transactions | List transactions |
Cardholders
Create and manage people who receive cards.
| Method | Endpoint | Description |
|---|
| GET | /cardholders | List all cardholders |
| POST | /cardholders | Create a cardholder |
| GET | /cardholders/{id} | Get cardholder details |
| PATCH | /cardholders/{id} | Update cardholder |
| DELETE | /cardholders/{id} | Delete cardholder |
Cards
Issue and manage virtual cards.
| Method | Endpoint | Description |
|---|
| GET | /cards | List all cards |
| POST | /cards | Create a card |
| GET | /cards/{id} | Get card details (with sensitive data) |
| PUT | /cards/{id} | Update spending limit |
| DELETE | /cards/{id} | Terminate card |
| GET | /cards/{id}/transactions | Get card transactions |
| POST | /cards/{id}/fund | Add funds to card |
| POST | /cards/{id}/unload | Withdraw funds from card |
| POST | /cards/{id}/freeze | Freeze card |
| POST | /cards/{id}/unfreeze | Unfreeze card |
Webhooks
Configure real-time notifications.
| Method | Endpoint | Description |
|---|
| GET | /webhooks | Get webhook configuration |
| POST | /webhooks | Set webhook URL |
| POST | /webhooks/simulate | Test webhook |
| Parameter | Type | Default | Description |
|---|
page | integer | 1 | Page number |
limit or perPage | integer | 50 | Items per page (max 100) |
{
"data": {
"list": [...],
"pagination": {
"totalItems": 156,
"totalPages": 4,
"currentPage": 1,
"itemsPerPage": 50
}
}
}
Interactive Playground
Each endpoint page includes an interactive playground where you can:
- Enter your credentials
- Fill in parameters
- Execute the request
- See the live response
The playground uses the production API. All operations involve real money and real data.
Need Help?
