Skip to main content
GET
/
programs
List programs
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/programs \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Programs retrieved",
  "data": [
    {
      "programId": "prg_01HXYZ9876ABCDEF0000",
      "name": "Fyatu VISA USD",
      "description": "Main USD virtual card program",
      "cardType": "VIRTUAL",
      "cardBrand": "VISA",
      "currency": "USD",
      "status": "ACTIVE",
      "environment": "LIVE",
      "limits": {
        "spendingLimitPerCard": {
          "cents": 500000,
          "displayValue": "5000.00"
        },
        "monthlySpendingLimit": {
          "cents": 1000000,
          "displayValue": "10000.00"
        },
        "maxCardLoad": {
          "cents": 100000,
          "displayValue": "1000.00"
        },
        "maxCardUnload": {
          "cents": 100000,
          "displayValue": "1000.00"
        }
      },
      "lowBalanceThreshold": {
        "cents": 10000,
        "displayValue": "100.00"
      },
      "stats": {
        "totalCards": 142,
        "totalCardholders": 38,
        "totalTransactions": 1204,
        "totalSpend": {
          "cents": 842500,
          "displayValue": "8425.00"
        }
      },
      "activatedAt": "2026-01-15T10:00:00Z",
      "pausedAt": null,
      "closedAt": null,
      "createdAt": "2026-01-10T09:00:00Z",
      "updatedAt": "2026-05-22T14:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0,
    "hasMore": false
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-22T15:00:00Z"
  }
}

​
Overview

Returns all card programs associated with your business in the current environment. A Card Program defines the contractual terms and limits negotiated between your business and FYATU — including supported card brand, currency, spending limits, and balance thresholds. Programs are created and configured by the FYATU team. This endpoint lets you read your program configuration via the API.

​
Query Parameters

ParameterTypeDefaultDescription
limitinteger20Results per page (max 100)
offsetinteger0Number of records to skip
statusstring—Filter by status: ACTIVE, PAUSED, CLOSED

​
Example

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

​
Success Response (200)

{
  "success": true,
  "status":  200,
  "message": "Programs retrieved",
  "data": [
    {
      "programId":   "prg_01HXYZ9876ABCDEF0000",
      "name":        "Fyatu VISA USD",
      "description": "Main USD virtual card program",
      "cardType":    "VIRTUAL",
      "cardBrand":   "VISA",
      "currency":    "USD",
      "status":      "ACTIVE",
      "environment": "LIVE",
      "limits": {
        "spendingLimitPerCard": {
          "cents":        500000,
          "displayValue": "5000.00"
        },
        "monthlySpendingLimit": {
          "cents":        1000000,
          "displayValue": "10000.00"
        },
        "maxCardLoad": {
          "cents":        100000,
          "displayValue": "1000.00"
        },
        "maxCardUnload": {
          "cents":        100000,
          "displayValue": "1000.00"
        }
      },
      "lowBalanceThreshold": {
        "cents":        10000,
        "displayValue": "100.00"
      },
      "stats": {
        "totalCards":        142,
        "totalCardholders":  38,
        "totalTransactions": 1204,
        "totalSpend": {
          "cents":        842500,
          "displayValue": "8425.00"
        }
      },
      "kycMode":     "MANAGED",
      "activatedAt": "2026-01-15T10:00:00Z",
      "pausedAt":    null,
      "closedAt":    null,
      "createdAt":   "2026-01-10T09:00:00Z",
      "updatedAt":   "2026-05-22T14:30:00Z"
    }
  ],
  "pagination": {
    "total":   1,
    "limit":   20,
    "offset":  0,
    "hasMore": false
  },
  "meta": {
    "requestId":  "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp":  "2026-05-22T15:00:00Z"
  }
}

​
Field Reference

FieldDescription
programIdUnique program identifier (prefix prg_)
cardTypeAlways VIRTUAL
cardBrandVISA or MASTERCARD
currencyISO 4217 currency code for cards issued under this program
statusACTIVE, PAUSED, or CLOSED
limits.spendingLimitPerCardMaximum lifetime spend allowed per card
limits.monthlySpendingLimitMaximum spend across all cards in a calendar month
limits.maxCardLoadMaximum single load amount per card (null = unlimited)
limits.maxCardUnloadMaximum single unload amount per card (null = unlimited)
lowBalanceThresholdProgram ledger balance that triggers a PROGRAM_BALANCE_LOW webhook event
stats.totalCardsTotal number of cards ever issued under this program
stats.totalCardholdersTotal number of unique cardholders
stats.totalTransactionsTotal number of transactions processed
stats.totalSpendCumulative spend across all cards
kycModeKYC verification mode for cardholders: MANAGED (Fyatu-managed async KYC), SHARED (your pre-verified docs, instant APPROVED), or MINIMAL (no KYC, instant WAIVED)
activatedAtWhen the program was activated; null if not yet active
pausedAtWhen the program was last paused; null if never paused
closedAtWhen the program was closed; null if not closed
Most businesses have one active program per environment. Multiple programs may exist if your business has separate agreements for different card brands or currencies.

​
Error Codes

CodeHTTPCause
INSUFFICIENT_SCOPE403Key lacks programs:read scope

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
status
enum<string>

Filter by status

Available options:
ACTIVE,
PAUSED,
CLOSED

Response

Programs retrieved

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Programs retrieved"

​
data
object[]
​
pagination
object
​
meta
object