Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/products \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Products retrieved",
  "data": [
    {
      "productId": "prd_01HXYZ1111ABCDEF0001",
      "programId": "prg_01HXYZ9876ABCDEF0000",
      "name": "Standard VISA Consumer",
      "scheme": "VISA",
      "cardType": "CONSUMER",
      "features": {
        "has3DS": true,
        "hasApplePay": true,
        "hasGooglePay": true,
        "hasJIT": false,
        "hasSpendControl": false,
        "hasMccControl": false
      },
      "status": "ACTIVE",
      "createdAt": "2026-01-10T09:00:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-25T10:00: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 all card products associated with your business across all programs. A Card Product is a specific card configuration within a program — it defines the card scheme (VISA/Mastercard), card type (Consumer/Corporate), the feature set available to cards issued under it, and the lifecycle controls enforced at issuance and funding time. Products are shared resources: they are always read from the LIVE database regardless of whether your API key is LIVE or SANDBOX. You can create products via POST /programs/:id/products and manage their lifecycle with the archive and activate endpoints.

Query Parameters

ParameterTypeDefaultDescription
limitinteger50Results per page (max 100)
offsetinteger0Number of records to skip

Example

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

Success Response (200)

{
  "success": true,
  "status":  200,
  "message": "Products retrieved",
  "data": [
    {
      "productId": "prd_01HXYZ1111ABCDEF0001",
      "programId": "prg_01HXYZ9876ABCDEF0000",
      "name":      "Standard VISA Consumer",
      "scheme":    "VISA",
      "cardType":  "CONSUMER",
      "features": {
        "has3DS":          true,
        "hasApplePay":     true,
        "hasGooglePay":    true,
        "hasJIT":          false,
        "hasSpendControl": false,
        "hasMccControl":   false
      },
      "controls": {
        "isReloadable":          true,
        "isOneTimeUse":          false,
        "cardTTLMonths":         36,
        "maxCardsPerCardholder": 5,
        "spendingLimit":         1000,
        "spendingPeriod":        "TRANSAMOUNT"
      },
      "status":    "ACTIVE",
      "createdAt": "2026-01-10T09:00:00Z"
    }
  ],
  "pagination": {
    "total":   1,
    "limit":   50,
    "offset":  0,
    "hasMore": false
  },
  "meta": {
    "requestId": "req_01HXY123456ABCDEF",
    "platform":  "Fyatu CaaS",
    "timestamp": "2026-05-25T10:00:00Z"
  }
}

Field Reference

Core Fields

FieldDescription
productIdUnique product identifier (prefix prd_)
programIdThe program this product belongs to
nameHuman-readable product name
schemeCard network — VISA or MASTERCARD
cardTypeCard usage type — CONSUMER or CORPORATE
statusACTIVE or ARCHIVED
createdAtISO 8601 creation timestamp

features Object

FieldTypeDescription
has3DSboolean3D Secure authentication enabled
hasApplePaybooleanApple Pay tokenisation enabled
hasGooglePaybooleanGoogle Pay tokenisation enabled
hasJITbooleanJust-In-Time funding — your system authorises each spend in real time
hasSpendControlbooleanPer-card spend limits are configured
hasMccControlbooleanMCC (merchant category) allow/block rules are configured

controls Object

FieldTypeDescription
isReloadablebooleanWhen false, POST /cards/{id}/fund is rejected for all cards under this product
isOneTimeUsebooleanWhen true, a card is automatically terminated after its first settled transaction
cardTTLMonthsinteger | nullMaximum card validity in months from issuance
maxCardsPerCardholderinteger | nullMaximum number of simultaneously active (non-TERMINATED) cards a cardholder may hold under this product
spendingLimitnumberMaximum spend per spendingPeriod in the program currency (USD)
spendingPeriodstringPeriod window for the spending limit — TRANSAMOUNT, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY, or LIFETIME
Products are always read from the LIVE database, even when using a SANDBOX API key. Use GET /programs/:id/products to list products scoped to a specific program.

Error Codes

CodeHTTPCause
INSUFFICIENT_SCOPE403Key lacks accounts:read scope

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:50

Results per page

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip

Required range: x >= 0

Response

Products retrieved

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Products retrieved"

data
object[]
pagination
object
meta
object