Get Cards/Card Details

Body Response

200 OK

ParameterTypeDescription
_embeddedobjectcards
array[object]
required
List of cards in the current page

id
string
required
Identification for a card

card_name
string
Account owner name

card_number
string
required
A masked card number that can be displayed to the customer.

> = 16 characters
> <= 16 characters
> Example:
> XXXXXXXXXXXX4521
> card_type
> string
> required
> Inform the card typeAllowed values:
DEBIT
CREDIT
ATM
activation_at
string
Card activation date

expiration_at
string
required
Card expiration date

inactive_date
string
Card inactivation date

holder_name
string
required
The name printed in the card.

<= 30 characters
issuer
string
required
Card's issuer

Example:
MASTER CARD
status
string
required
Card's current status

Allowed values:
ACTIVE
CLOSED
INACTIVE
BLOCKED
LOST
STOLEN
CANCELED
description
string
Card's description

custom_type
string
Card type customized by bank client

custom_status
string
Card status customized by bank client

account_id
string
Account associated to the card

deactivation_note
string
It contains notes about the deactivation of card.

_links
object
required
HAL API self link
string
required
Brief description for a transaction

value
object
required
A tuple with value and currency

booked_at
string
Transaction's book date (post date)

value_at
string
required
Transaction's value date (effective date)

status
string
required
Allowed values:
UNDEFINED
PENDING
BOOKED
POSTED
type
string
required
Allowed values:
UNDEFINED
CREDIT_CARD
PAYMENT
WITHDRAWAL
DEFAULT
TRANSFER
ADD_ON
DEPOSIT
PURCHASE
CHECK
OTHER
LOAN_PAYMENTS
flow
string
required
Transaction's flow - either a debit or a credit in an account

Allowed values:
CREDIT
DEBIT
custom_type
string
Transaction type customized by bank client

custom_status
string
Transaction status customized by bank client

value_details
object
total_principal_balance
string
Total principal balance

check_number
string
Check number

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

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

"name" (string)

"description" (string)
yes (name and description)
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!