> ## 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.
# Account Info
> Retrieve your complete program configuration — identity, balance, pricing schedule, feature flags, and all restrictions. GET /info. Requires accounts:read scope.
## Overview
Returns a comprehensive snapshot of your active card program in a single call. Use this endpoint to:
* Verify your program is active before issuing cards
* Display your pricing schedule to internal stakeholders
* Enforce client-side restriction logic (restricted MCCs, blocked countries) before calling card APIs
* Seed your application's configuration cache at startup
Programs are **shared resources** — always read from the LIVE database regardless of whether your API key is LIVE or SANDBOX. Your balance, however, is environment-scoped: a SANDBOX key reads your sandboxed ledger balance.
## Example
```bash cURL theme={null}
curl https://api.fyatu.com/api/v3.20/info \
-H "Authorization: Bearer $FYATU_API_KEY"
```
```javascript Node.js theme={null}
const resp = await fetch('https://api.fyatu.com/api/v3.20/info', {
headers: { 'Authorization': `Bearer ${process.env.FYATU_API_KEY}` }
});
const { data } = await resp.json();
console.log('Program:', data.name, '|', data.status);
console.log('Balance:', data.balance.amount, data.balance.currency);
console.log('Card issuance fee:', data.pricing.flat.cardIssuance, data.pricing.currency);
console.log('Restricted MCCs:', data.restrictions.restrictedMccs);
```
```python Python theme={null}
import os, requests
resp = requests.get(
'https://api.fyatu.com/api/v3.20/info',
headers={'Authorization': f'Bearer {os.environ["FYATU_API_KEY"]}'}
)
data = resp.json()['data']
print(data['name'], data['status'])
print('Balance:', data['balance']['amount'], data['balance']['currency'])
print('Card issuance fee:', data['pricing']['flat']['cardIssuance'])
```
## Success Response (200)
```json theme={null}
{
"success": true,
"status": 200,
"message": "Account info retrieved",
"data": {
"businessId": "BUS1A2B3C4D5E6F",
"programId": "prg_01HXYZ9876ABCDEF0000",
"name": "Standard VISA Consumer Program",
"status": "ACTIVE",
"currency": "USD",
"kycMode": "MANAGED",
"activatedAt": "2026-01-10T09:00:00Z",
"pricing": {
"currency": "USD",
"flat": {
"monthly": 0.00,
"cardIssuance": 1.00,
"tokenization": 0.50,
"cardMaintenance": 0.00,
"cardTermination": 0.00,
"cardReplacement": 5.00,
"kycPerVerification": 1.00,
"decline": 0.25,
"chargeback": 15.00
},
"deposit": {
"percent": 1.00,
"flat": 0.00
},
"cardFunding": {
"percent": 0.00,
"flat": 0.00,
"min": 0.00
},
"authorization": {
"percent": 0.00,
"flat": 0.00,
"min": 0.00
},
"crossBorder": {
"percent": 1.50,
"flat": 0.00,
"min": 0.25
},
"settlement": {
"percent": 0.00,
"flat": 0.00,
"min": 0.00
},
"fx": {
"percent": 0.00
}
},
"features": {
"availableSchemes": ["VISA"],
"has3DS": true,
"hasApplePay": true,
"hasGooglePay": true,
"hasJIT": false,
"hasSpendControl": true,
"hasMccControl": false,
"hasConsumer": true,
"hasCorporate": false
},
"restrictions": {
"restrictedMccs": ["7995", "7801"],
"availableMccs": null,
"restrictedCardholderCountries": ["KP", "IR", "SY"],
"restrictedMerchantCountries": [],
"availableRegions": null,
"blockedCategories": [],
"allowedCategories": []
},
"stats": {
"totalCards": 312,
"totalCardholders": 148,
"totalTransactions": 4721
}
},
"meta": {
"requestId": "req_01HXY123456ABCDEF",
"platform": "Fyatu CaaS",
"timestamp": "2026-05-26T10:45:00Z"
}
}
```
## Field Reference
### Identity
| Field | Description |
| ------------- | ----------------------------------------------------------------------- |
| `businessId` | Your business identifier |
| `programId` | Your active program identifier (prefix `prg_`) |
| `name` | Program name as configured |
| `status` | `ACTIVE`, `PAUSED`, or `SUSPENDED` |
| `currency` | ISO 4217 currency code (e.g. `USD`) |
| `kycMode` | How KYC is handled — `MANAGED` (Fyatu runs KYC) or `SHARED` / `MINIMAL` |
| `activatedAt` | ISO 8601 timestamp when the program went live |
### `pricing` Object
Your complete fee schedule, sourced from your program catalog. All amounts are in `pricing.currency`.
#### `pricing.flat` — Fixed fees charged per event
| Field | Description |
| -------------------- | ----------------------------------------------------- |
| `monthly` | Recurring monthly platform fee |
| `cardIssuance` | Charged when a card is successfully issued |
| `tokenization` | Charged per Apple Pay or Google Pay token provisioned |
| `cardMaintenance` | Recurring per-card maintenance fee (if applicable) |
| `cardTermination` | Charged when a card is terminated |
| `cardReplacement` | Charged when a card is replaced |
| `kycPerVerification` | Charged per successful cardholder KYC verification |
| `decline` | Charged per declined authorization |
| `chargeback` | Charged per disputed chargeback case |
#### `pricing.deposit` — Account top-up fees
| Field | Description |
| --------- | ----------------------------------------------------- |
| `percent` | Percentage of the deposited amount (e.g. `1.00` = 1%) |
| `flat` | Fixed fee per deposit |
#### `pricing.cardFunding` — Fees when loading funds onto a card
| Field | Description |
| --------- | --------------------------------------------------------------------- |
| `percent` | Percentage of the funded amount |
| `flat` | Fixed fee per funding operation |
| `min` | Minimum fee applied when `percent` calculation falls below this value |
#### `pricing.authorization` — Per-authorization fees
| Field | Description |
| --------- | ----------------------------------- |
| `percent` | Percentage of the authorized amount |
| `flat` | Fixed fee per authorization event |
| `min` | Minimum fee |
#### `pricing.crossBorder` — Fees on transactions where the merchant country differs from the card's issuing country
| Field | Description |
| --------- | ------------------------------------ |
| `percent` | Percentage of the transaction amount |
| `flat` | Fixed cross-border fee |
| `min` | Minimum cross-border fee applied |
#### `pricing.settlement` — Fees applied at settlement (cleared transactions)
| Field | Description |
| --------- | -------------------------------- |
| `percent` | Percentage of the settled amount |
| `flat` | Fixed settlement fee |
| `min` | Minimum settlement fee |
#### `pricing.fx` — Foreign-exchange mark-up
| Field | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------- |
| `percent` | FX mark-up percentage on top of the scheme rate. `0.00` means the raw scheme FX rate applies with no additional mark-up |
### `features` Object
What your program catalog supports. These determine which options are valid when calling `POST /programs/:id/products`.
| Field | Type | Description |
| ------------------ | --------- | --------------------------------------------------------- |
| `availableSchemes` | string\[] | Card networks available to your program (e.g. `["VISA"]`) |
| `has3DS` | boolean | 3D Secure authentication is available |
| `hasApplePay` | boolean | Apple Pay tokenisation is available |
| `hasGooglePay` | boolean | Google Pay tokenisation is available |
| `hasJIT` | boolean | Just-In-Time funding is available |
| `hasSpendControl` | boolean | Per-card spend limits can be configured |
| `hasMccControl` | boolean | MCC allow/block rules can be configured |
| `hasConsumer` | boolean | `CONSUMER` card type is available |
| `hasCorporate` | boolean | `CORPORATE` card type is available |
### `restrictions` Object
All active restrictions on your program. Apply these on the client side before calling card APIs to avoid predictable errors.
| Field | Type | Description |
| ------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `restrictedMccs` | string\[] \| null | MCC codes that are globally blocked on your program. Cards cannot be used at merchants with these codes |
| `availableMccs` | string\[] \| null | If non-null, **only** these MCCs are permitted. Any merchant outside this list is blocked |
| `restrictedCardholderCountries` | string\[] \| null | ISO 3166-1 alpha-2 codes — cardholders from these countries cannot be onboarded |
| `restrictedMerchantCountries` | string\[] \| null | ISO 3166-1 alpha-2 codes — cards cannot be used at merchants in these countries |
| `availableRegions` | string\[] \| null | If non-null, only cardholders from these regions are eligible |
| `blockedCategories` | string\[] | Program-level merchant category overrides set by your account. Possible values: `RETAIL`, `TRAVEL`, `ENTERTAINMENT`, `DINING`, `FUEL`, `HEALTHCARE`, `EDUCATION`, `UTILITIES`, `GOVERNMENT`, `OTHER` |
| `allowedCategories` | string\[] | If non-empty, only merchants in these categories are permitted at the program level |
### `stats` Object
Aggregated counters for your program.
| Field | Description |
| ------------------- | ------------------------------------------ |
| `totalCards` | Total cards ever issued under this program |
| `totalCardholders` | Total cardholder profiles created |
| `totalTransactions` | Total transaction events recorded |
## Error Codes
| Code | HTTP | Cause |
| -------------------- | ---- | ----------------------------------------- |
| `PROGRAM_NOT_FOUND` | 404 | No active program exists for this account |
| `INSUFFICIENT_SCOPE` | 403 | Key lacks `accounts:read` scope |
| `INTERNAL_ERROR` | 500 | Server error |
## OpenAPI
````yaml v3.20/openapi.json GET /info
openapi: 3.1.0
info:
title: FYATU CaaS API v3.20
description: >-
FYATU Cards-as-a-Service API — API key authentication, Cardholder
lifecycle, Card issuance, Transactions, Webhooks, and Programs.
version: 3.20.0
contact:
name: FYATU Support
url: https://fyatu.com
email: support@fyatu.com
servers:
- url: https://api.fyatu.com/api/v3.20
description: >-
FYATU CaaS API — the environment (LIVE or SANDBOX) is determined by the
API key, not the URL
security:
- BearerAuth: []
tags:
- name: Meta
description: Liveness, account info, and supported event types
- name: Account
description: Account-level balance and funding status
- name: Programs
description: Read card program configuration
- name: Cardholders
description: Create and manage cardholder profiles
- name: Cards
description: Issue, fund, freeze, and terminate virtual cards
- name: Transactions
description: Read-only card transaction history
- name: Webhooks
description: Manage webhook endpoints for real-time event delivery
- name: Products
description: Read card product configurations
paths:
/info:
get:
tags:
- Account
summary: Get account info
description: >-
Returns a comprehensive snapshot of your active card program in a single
call: program identity, real-time balance, card limits, full pricing
schedule, feature flags, and all MCC / country restrictions. Use this as
your authoritative configuration source at application startup.
operationId: getAccountInfo
responses:
'200':
description: Account info retrieved
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
status:
type: integer
example: 200
message:
type: string
example: Account info retrieved
data:
type: object
properties:
businessId:
type: string
description: Your business identifier.
example: BUS1A2B3C4D5E6F
programId:
type: string
description: Your active program identifier (prefix `prg_`).
example: prg_01HXYZ9876ABCDEF0000
name:
type: string
description: Program name as configured.
example: Standard VISA Consumer Program
status:
type: string
enum:
- ACTIVE
- PAUSED
- SUSPENDED
example: ACTIVE
currency:
type: string
description: ISO 4217 currency code.
example: USD
kycMode:
type: string
enum:
- MANAGED
- SHARED
- MINIMAL
description: >-
How KYC is handled. `MANAGED` means Fyatu runs KYC on
your behalf.
example: MANAGED
activatedAt:
type: string
format: date-time
nullable: true
description: When the program went live.
example: '2026-01-10T09:00:00Z'
pricing:
type: object
description: >-
Complete fee schedule from your program catalog. All
amounts are in `pricing.currency`.
properties:
currency:
type: string
description: Currency for all fee amounts.
example: USD
flat:
type: object
description: Fixed fees charged per event.
properties:
monthly:
type: number
format: float
description: Recurring monthly platform fee.
example: 0
cardIssuance:
type: number
format: float
description: Charged when a card is successfully issued.
example: 1
tokenization:
type: number
format: float
description: >-
Charged per Apple Pay / Google Pay token
provisioned.
example: 0.5
cardMaintenance:
type: number
format: float
description: Recurring per-card maintenance fee.
example: 0
cardTermination:
type: number
format: float
description: Charged when a card is terminated.
example: 0
cardReplacement:
type: number
format: float
description: Charged when a card is replaced.
example: 5
kycPerVerification:
type: number
format: float
description: Charged per successful KYC verification.
example: 1
decline:
type: number
format: float
description: Charged per declined authorization.
example: 0.25
chargeback:
type: number
format: float
description: Charged per chargeback case.
example: 15
deposit:
type: object
description: Fees applied when topping up your account balance.
properties:
percent:
type: number
format: float
description: Percentage of the deposited amount.
example: 1
flat:
type: number
format: float
description: Fixed fee per deposit.
example: 0
cardFunding:
type: object
description: >-
Fees when loading funds onto a card via `POST
/cards/{id}/fund`.
properties:
percent:
type: number
format: float
example: 0
flat:
type: number
format: float
example: 0
min:
type: number
format: float
description: >-
Minimum fee when percent calculation falls
below this value.
example: 0
authorization:
type: object
description: Per-authorization fees.
properties:
percent:
type: number
format: float
example: 0
flat:
type: number
format: float
example: 0
min:
type: number
format: float
example: 0
crossBorder:
type: object
description: >-
Fees when the merchant country differs from the
card's issuing country.
properties:
percent:
type: number
format: float
example: 1.5
flat:
type: number
format: float
example: 0
min:
type: number
format: float
example: 0.25
settlement:
type: object
description: Fees applied at settlement (cleared transactions).
properties:
percent:
type: number
format: float
example: 0
flat:
type: number
format: float
example: 0
min:
type: number
format: float
example: 0
fx:
type: object
description: >-
Foreign-exchange mark-up on top of the scheme
rate.
properties:
percent:
type: number
format: float
description: >-
`0.00` means the raw scheme FX rate applies
with no additional mark-up.
example: 0
features:
type: object
description: Capabilities available under your program catalog.
properties:
availableSchemes:
type: array
items:
type: string
description: Card networks available.
example:
- VISA
has3DS:
type: boolean
description: 3D Secure is available.
example: true
hasApplePay:
type: boolean
description: Apple Pay tokenisation is available.
example: true
hasGooglePay:
type: boolean
description: Google Pay tokenisation is available.
example: true
hasJIT:
type: boolean
description: Just-In-Time funding is available.
example: false
hasSpendControl:
type: boolean
description: Per-card spend limits can be configured.
example: true
hasMccControl:
type: boolean
description: MCC allow/block rules can be configured.
example: false
hasConsumer:
type: boolean
description: '`CONSUMER` card type is available.'
example: true
hasCorporate:
type: boolean
description: '`CORPORATE` card type is available.'
example: false
restrictions:
type: object
description: All active restrictions on your program.
properties:
restrictedMccs:
type: array
items:
type: string
nullable: true
description: >-
MCC codes globally blocked. Cards cannot be used
at merchants with these codes.
example:
- '7995'
- '7801'
availableMccs:
type: array
items:
type: string
nullable: true
description: If non-null, only these MCCs are permitted.
example: null
restrictedCardholderCountries:
type: array
items:
type: string
nullable: true
description: >-
ISO 3166-1 alpha-2 — cardholders from these
countries cannot be onboarded.
example:
- KP
- IR
- SY
restrictedMerchantCountries:
type: array
items:
type: string
nullable: true
description: >-
ISO 3166-1 alpha-2 — cards cannot be used at
merchants in these countries.
example: []
availableRegions:
type: array
items:
type: string
nullable: true
description: >-
If non-null, only cardholders from these regions
are eligible.
example: null
blockedCategories:
type: array
items:
type: string
description: Program-level merchant category overrides.
example: []
allowedCategories:
type: array
items:
type: string
description: >-
If non-empty, only these merchant categories are
permitted at the program level.
example: []
stats:
type: object
description: Aggregated counters for your program.
properties:
totalCards:
type: integer
example: 312
totalCardholders:
type: integer
example: 148
totalTransactions:
type: integer
example: 4721
meta:
$ref: '#/components/schemas/Meta'
example:
success: true
status: 200
message: Account info retrieved
data:
businessId: BUS1A2B3C4D5E6F
programId: prg_01HXYZ9876ABCDEF0000
name: Standard VISA Consumer Program
status: ACTIVE
currency: USD
kycMode: MANAGED
activatedAt: '2026-01-10T09:00:00Z'
pricing:
currency: USD
flat:
monthly: 0
cardIssuance: 1
tokenization: 0.5
cardMaintenance: 0
cardTermination: 0
cardReplacement: 5
kycPerVerification: 1
decline: 0.25
chargeback: 15
deposit:
percent: 1
flat: 0
cardFunding:
percent: 0
flat: 0
min: 0
authorization:
percent: 0
flat: 0
min: 0
crossBorder:
percent: 1.5
flat: 0
min: 0.25
settlement:
percent: 0
flat: 0
min: 0
fx:
percent: 0
features:
availableSchemes:
- VISA
has3DS: true
hasApplePay: true
hasGooglePay: true
hasJIT: false
hasSpendControl: true
hasMccControl: false
hasConsumer: true
hasCorporate: false
restrictions:
restrictedMccs:
- '7995'
- '7801'
availableMccs: null
restrictedCardholderCountries:
- KP
- IR
- SY
restrictedMerchantCountries: []
availableRegions: null
blockedCategories: []
allowedCategories: []
stats:
totalCards: 312
totalCardholders: 148
totalTransactions: 4721
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-26T10:45:00Z'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
description: No active program found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
success: false
status: 404
message: No active program found for this account
error:
code: PROGRAM_NOT_FOUND
detail: No active program found for this account
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-26T10:45:00Z'
'429':
$ref: '#/components/responses/RateLimitExceeded'
'500':
$ref: '#/components/responses/InternalError'
components:
schemas:
Meta:
type: object
properties:
requestId:
type: string
example: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform:
type: string
example: Fyatu CaaS
timestamp:
type: string
format: date-time
example: '2026-05-22T15:00:00Z'
Error:
type: object
properties:
success:
type: boolean
example: false
status:
type: integer
example: 422
message:
type: string
example: Human readable message
error:
$ref: '#/components/schemas/ErrorBody'
meta:
$ref: '#/components/schemas/Meta'
ErrorBody:
type: object
properties:
code:
type: string
example: VALIDATION_ERROR
detail:
type: string
example: dateOfBirth must be in YYYY-MM-DD format
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
missing:
summary: API key missing
value:
success: false
status: 401
message: API key is required
error:
code: AUTH_TOKEN_MISSING
detail: API key is required
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-22T15:00:00Z'
invalid:
summary: API key invalid
value:
success: false
status: 401
message: Invalid API key
error:
code: AUTH_TOKEN_INVALID
detail: Invalid API key
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-22T15:00:00Z'
Forbidden:
description: Scope denied or business suspended
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
success: false
status: 403
message: Scope denied
error:
code: INSUFFICIENT_SCOPE
detail: This endpoint requires the cards:write scope
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-22T15:00:00Z'
RateLimitExceeded:
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
success: false
status: 429
message: Rate limit exceeded
error:
code: RATE_LIMIT_EXCEEDED
detail: Too many requests
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-22T15:00:00Z'
InternalError:
description: Unexpected server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
success: false
status: 500
message: Internal error
error:
code: INTERNAL_ERROR
detail: An unexpected error occurred
meta:
requestId: req_a1b2c3d4e5f6a7b8c9d0e1f2
platform: Fyatu CaaS
timestamp: '2026-05-22T15:00:00Z'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: >-
API key from the FYATU CaaS portal. Pass as `Authorization: Bearer
`.
````