Generate card statement
Cards
Generate Card Statement
Generate a white-label PDF statement for a card. POST /cards//statement. Requires cards:read scope.
POST
Generate card statement
Overview
Generates a bank-grade PDF statement for a card and returns a download link. The statement lists every settled card transaction grouped by day (funding, charges, fees, reversals, termination refunds …) with a summary of Total Money In / Out, Available Balance, and — when the provider ledger and available balance differ — a Pending Value line so the summary always balances. Because CaaS businesses have no stored branding, you supply your own white-label branding in the request body. Every field is optional; anything omitted falls back to a sensible default (brandName defaults to your account display name, and the contact line is dropped entirely when
you provide no contactEmail/phone).
The returned
url points to cdn.fyatu.com and is valid for 24 hours, after which the file is
automatically deleted. Fetch and store the PDF on your side if you need it longer.Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The card ID (prefix crd_) |
Body Parameters (all optional)
| Field | Type | Description |
|---|---|---|
brandColor | string | Hex color for the header, accents and totals row (e.g. #2563eb) |
brandName | string | Business/brand name shown in the header and footer. Defaults to your account display name |
brandLogo | string | Publicly reachable PNG or JPG logo URL, rendered in the header |
contactEmail | string | Support email printed in the footer |
address | string | Business address printed under the header |
phone | string | Support phone printed in the footer |
website | string | Website printed in the header strip |
Example
Success Response (200)
Error Codes
| Code | HTTP | Cause |
|---|---|---|
CARD_NOT_FOUND | 404 | Card does not exist or belongs to another business/environment |
CARD_PROVISIONING | 409 | Card is still being provisioned by the card network |
PROVIDER_ERROR | 502 | Card network unavailable — retry with exponential back-off |
SERVICE_UNAVAILABLE | 503 | Statement generation is temporarily unavailable |
INSUFFICIENT_SCOPE | 403 | Key lacks cards:read scope |
Authorizations
API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.
Path Parameters
Body
application/json
Hex brand color used for the header, accents and totals row.
Example:
"#2563eb"
Business / brand name. Defaults to your account display name when omitted.
Example:
"Acme Cards Ltd"
Publicly reachable PNG or JPG logo URL shown in the statement header.
Example:
"https://acmecards.com/logo.png"
Example:
"support@acmecards.com"
Example:
"128 City Road, London EC1V 2NX, United Kingdom"
Example:
"+44 20 7946 0958"
Example:
"https://acmecards.com"

