Skip to main content
GET
/
info
Get account info
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/info \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

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.

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

curl https://api.fyatu.com/api/v3.20/info \
  -H "Authorization: Bearer $FYATU_API_KEY"

Success Response (200)

{
  "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

FieldDescription
businessIdYour business identifier
programIdYour active program identifier (prefix prg_)
nameProgram name as configured
statusACTIVE, PAUSED, or SUSPENDED
currencyISO 4217 currency code (e.g. USD)
kycModeHow KYC is handled — MANAGED (Fyatu runs KYC) or SHARED / MINIMAL
activatedAtISO 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

FieldDescription
monthlyRecurring monthly platform fee
cardIssuanceCharged when a card is successfully issued
tokenizationCharged per Apple Pay or Google Pay token provisioned
cardMaintenanceRecurring per-card maintenance fee (if applicable)
cardTerminationCharged when a card is terminated
cardReplacementCharged when a card is replaced
kycPerVerificationCharged per successful cardholder KYC verification
declineCharged per declined authorization
chargebackCharged per disputed chargeback case

pricing.deposit — Account top-up fees

FieldDescription
percentPercentage of the deposited amount (e.g. 1.00 = 1%)
flatFixed fee per deposit

pricing.cardFunding — Fees when loading funds onto a card

FieldDescription
percentPercentage of the funded amount
flatFixed fee per funding operation
minMinimum fee applied when percent calculation falls below this value

pricing.authorization — Per-authorization fees

FieldDescription
percentPercentage of the authorized amount
flatFixed fee per authorization event
minMinimum fee

pricing.crossBorder — Fees on transactions where the merchant country differs from the card’s issuing country

FieldDescription
percentPercentage of the transaction amount
flatFixed cross-border fee
minMinimum cross-border fee applied

pricing.settlement — Fees applied at settlement (cleared transactions)

FieldDescription
percentPercentage of the settled amount
flatFixed settlement fee
minMinimum settlement fee

pricing.fx — Foreign-exchange mark-up

FieldDescription
percentFX 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.
FieldTypeDescription
availableSchemesstring[]Card networks available to your program (e.g. ["VISA"])
has3DSboolean3D Secure authentication is available
hasApplePaybooleanApple Pay tokenisation is available
hasGooglePaybooleanGoogle Pay tokenisation is available
hasJITbooleanJust-In-Time funding is available
hasSpendControlbooleanPer-card spend limits can be configured
hasMccControlbooleanMCC allow/block rules can be configured
hasConsumerbooleanCONSUMER card type is available
hasCorporatebooleanCORPORATE 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.
FieldTypeDescription
restrictedMccsstring[] | nullMCC codes that are globally blocked on your program. Cards cannot be used at merchants with these codes
availableMccsstring[] | nullIf non-null, only these MCCs are permitted. Any merchant outside this list is blocked
restrictedCardholderCountriesstring[] | nullISO 3166-1 alpha-2 codes — cardholders from these countries cannot be onboarded
restrictedMerchantCountriesstring[] | nullISO 3166-1 alpha-2 codes — cards cannot be used at merchants in these countries
availableRegionsstring[] | nullIf non-null, only cardholders from these regions are eligible
blockedCategoriesstring[]Program-level merchant category overrides set by your account. Possible values: RETAIL, TRAVEL, ENTERTAINMENT, DINING, FUEL, HEALTHCARE, EDUCATION, UTILITIES, GOVERNMENT, OTHER
allowedCategoriesstring[]If non-empty, only merchants in these categories are permitted at the program level

stats Object

Aggregated counters for your program.
FieldDescription
totalCardsTotal cards ever issued under this program
totalCardholdersTotal cardholder profiles created
totalTransactionsTotal transaction events recorded

Error Codes

CodeHTTPCause
PROGRAM_NOT_FOUND404No active program exists for this account
INSUFFICIENT_SCOPE403Key lacks accounts:read scope
INTERNAL_ERROR500Server error

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Response

Account info retrieved

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Account info retrieved"

data
object
meta
object