Fetch Cards

Associated with a contact

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

fsi-cards:read

Body Response - Schema

200 (the cards list)

ParameterTypeDescriptionRequired
_embeddedobject"_embedded" subdivides into:

1 - "cards" (array[object]) - list of cards in the current page.
1.1 - "id" (string) - identification for a card. Required.
1.2 - "card_name" (string) - card name.
1.3 - "card_number" (string) - a masked card number that can be displayed to the customer.

> = 16 characters
> <= 16 characters
> Example:
> XXXXXXXXXXXX4521. Required.
> 1.4 - "card_type" (string) - inform the card type. Allowed values:
> "DEBIT", "CREDIT". Required.
> 1.5 - "activation_at" (string) - card activation date.
> 1.6 - "expiration_at" (string) - card expiration date. Required.
> 1.7 - "inactive_date" (string) - card inactivation date.
> 1.8 - "holder_name" (string) - the name printed in the card.
> <= 30 characters. Required.
> 1.9 - "issuer" (string) - card's issuer. Example:
> "MASTER CARD".
> 1.10 - "status" (string) - card's current status. Allowed values: "ACTIVE",
> "CLOSED", "INACTIVE",
> "BLOCKED", "LOST_STOLEN". Required.
> 1.11 - "total_credit_limit" (string) - total credit limit.
> 1.12 - "available_balance" (string) - card available balance.
> 1.13 - "total_amount_due" (string) - card total amount due.
> 1.14 - "description" (string) - card's description.
> 1.15 - "due_date" (string
> )
- card payment due date.
> 1.16 - "minimum_payment" (string) - card minimum payment.
> 1.17 - "interest_rate" (string) - card interest rate.
> 1.18 - "periodic_frequency" (string) - card payment periodic frequency.
> 1.19 - "custom_type" (string) - card type customized by bank client.
> 1.20 - "custom_status" (string) - card status customized by bank client.
> 1.21 - "_links" (string) - HAL API self link. Required.
> 1.21.1 - "self" (object) - link of the current page. Required.
> 1.21.1.1 - "href" (string) - address of the resource.
yes
totalintegerthe total number of itemsyes

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

API Availability

The FSI Integrations API has been in General Availability since January 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!