Skip to main content
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

Body Parameters (all optional)

Example

Success Response (200)

Error Codes

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
brandColor
string

Hex brand color used for the header, accents and totals row.

Example:

"#2563eb"

brandName
string

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"

contactEmail
string
Example:

"support@acmecards.com"

address
string
Example:

"128 City Road, London EC1V 2NX, United Kingdom"

phone
string
Example:

"+44 20 7946 0958"

website
string
Example:

"https://acmecards.com"

Response

200 - application/json

Statement generated

success
boolean
status
integer
message
string
data
object
meta
object