Data modelsBanking

Cards

Debit, credit and prepaid cards, with their limits and their movements
View as Markdown

Where it lives: at cards in the Financial Position, and on its own from the cards endpoint.

One endpoint returns all three kinds, and sub_family says which one you are holding. They share most of their shape; what differs is the part that matters for risk.

Credit cards

The ones that carry debt: limit is what the issuer granted, disposed is what has been used, available is what is left.

idstringRequiredformat: "object-id"
product"financial_card"Required
sub_family"financial_card:credit"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
identifierobjectRequired
PAN
customer_segmentenumRequired
product_namestringRequired
Product name
statusenumRequired
Allowed values:
entity_countrystringOptionalformat: "country"
Entity country
entity_codestringOptional
Entity code
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
holder_namestringOptional
Card holder name
expiration_datedateOptional
Card expiration date
linked_accountobjectOptional
Linked account, if proceeds
availableobjectOptional
The current amount of credit that a user has access to, based on their credit limit minus any current outstanding balances or pending transactions. It indicates the remaining amount the user can still borrow or use.
disposedobjectOptional
The current amount of credit that a user has used or withdrawn.
limitobjectOptional
The maximum amount of credit that a financial institution extends to a client through a line of credit. This represents the maximum amount of credit that a user can use or withdraw.
payment_amountobjectOptional
The smallest amount that must be paid by a specified due date to keep the account in good standing and avoid potential penalties or additional interest charges. This amount generally covers the accrued interest and may include a portion of the principal balance. Paying only this amount by the due date may result in carrying a balance to the next billing cycle, which could incur interest.
next_payment_datedateOptional
Next Payment Date
billing_period_startdateOptional
Period Start Date
billing_period_enddateOptional
Period End Date
transactionslist of objectsOptional
Card transactions

Debit cards

Bound to an account, spending its balance rather than a credit line.

idstringRequiredformat: "object-id"
product"financial_card"Required
sub_family"financial_card:debit"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
identifierobjectRequired
PAN
customer_segmentenumRequired
product_namestringRequired
Product name
statusenumRequired
Allowed values:
entity_countrystringOptionalformat: "country"
Entity country
entity_codestringOptional
Entity code
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
holder_namestringOptional
Card holder name
expiration_datedateOptional
Card expiration date
linked_accountobjectOptional
Linked account, if proceeds
transactionslist of objectsOptional
Card transactions

Prepaid cards

Loaded in advance, with a balance of their own.

idstringRequiredformat: "object-id"
product"financial_card"Required
sub_family"financial_card:prepaid"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
identifierobjectRequired
PAN
customer_segmentenumRequired
product_namestringRequired
Product name
statusenumRequired
Allowed values:
entity_countrystringOptionalformat: "country"
Entity country
entity_codestringOptional
Entity code
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
holder_namestringOptional
Card holder name
expiration_datedateOptional
Card expiration date
linked_accountobjectOptional
Linked account, if proceeds
availableobjectOptional
For cards with a prepaid function, this indicates the current available prepaid balance that a user can access.
transactionslist of objectsOptional
Card transactions

Type, status and brand

Allowed values:
Allowed values:

Movements

Card transactions are shaped like account transactions but shorter — a card movement has no running balance of its own.

typeenumRequired
Transaction type
statusenumRequired
Transaction status
value_datedateOptional
amountobjectOptional
Transaction amount
descriptionslist of stringsOptional
Original transaction descriptions
provider_idstringOptional
Unique ID for the transaction in the provider system
merchantobjectOptional
Merchant information, if available

Card numbers are never reconstructed. What comes back is what the institution itself displays — a masked number — and it is handled as protected data end to end. Use identifier to recognise the same card across extractions, not to store a PAN.