Skip to main content
GET
Get Card Applications for Main Card

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-audit-user
string

Optional audit user header

Query Parameters

mainCardId
string<uuid>
required

Unique identifier of the main card for which you want to retrieve the list of card applications.

Response

Successful retrieval of card applications.

id
string<uuid>

Unique identifier of a card.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

createdAt
string<date-time>

The date and time when the card was created.

updatedAt
string<date-time>

The date and time when the object/entity was updated last time.

programId
string<uuid>

The program ID associated with the card.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

cardholderId
string<uuid>

Unique identifier of the cardholder associated with the card.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

accountId
string

Unique identifier of the account associated with the card.

Required string length: 1 - 36
Pattern: ^[a-zA-Z0-9-]+$
Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

plastic
object
cardVersions
object[]

Card versions ordered by sequence number ascending.

role
enum<string>

The role of the card. Multi application cards will have one main card and multiple card applications. Single cards will be treated as main cards.

Available options:
MAIN_CARD,
CARD_APPLICATION
Example:

"MAIN_CARD"

mainCardId
string<uuid>

Unique identifier of the main card. Populated if this card is part of a card application

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

cardConfigurationCode
string

A unique code to identify the card configuration. Max character limit is 36.

Required string length: 1 - 36
Pattern: ^[A-Za-z0-9_-]+$
Example:

"MC_DEBIT_1"

cardConfigurationType
enum<string>

The type of card defined by this card configuration.

Available options:
DEBIT,
CREDIT,
COMBO
Example:

"CREDIT"

cardScheme
enum<string>
Available options:
MASTERCARD,
VISA
Example:

"MASTERCARD"

maskedPan
string

A masked version of the primary account number

Example:

"123456______4285"

pinStatus
enum<string>
  • GENERATED - A pin has been randomly generated for the card.
  • WAITING - A pin is waiting to be set on the card.
  • SET - A pin has been manually set on the card.
  • INHERITED - For card applications only. The pin status is inherited from the main card.
Available options:
GENERATED,
WAITING,
SET,
INHERITED
Example:

"GENERATED"

cardStatus
enum<string>
  • ACTIVE - Card is active and is enabled for normal usage.
  • BLOCKED - Card is temporarily blocked.
  • BLOCKED_SUSPECTED_FRAUD - Card is temporarily blocked due to suspected fraud.
  • CLOSED_DUE_TO_FRAUD - Card has been closed due to fraud.
  • CLOSED_LOST - Card has been closed due to being lost.
  • CLOSED_STOLEN - Card has been closed due to being stolen.
  • CLOSED - Card has been manually closed.
  • CLOSED_EXPIRED - Card has no active or initial card versions and cannot be used.
Available options:
ACTIVE,
BLOCKED,
BLOCKED_SUSPECTED_FRAUD,
CLOSED_DUE_TO_FRAUD,
CLOSED_LOST,
CLOSED_STOLEN,
CLOSED,
CLOSED_EXPIRED
Example:

"ACTIVE"

automaticRenewal
boolean

A flag indicating whether automatic renewal is enabled or not.

digitalLayoutCode
string

The digital layout code for the card. Max character limit is 36.

Required string length: 1 - 36
Pattern: ^[a-zA-Z0-9-]+$
Example:

9

multiApplicationProperties
object
updateCount
integer

The version number of the entity.

Example:

1

additionalValues
object

You can include up to 30 additional key-value pairs in the embossing file sent to the card manufacturer.

  • Keys must follow the pattern: ^[a-zA-Z0-9-]{1,36}$ (only letters, numbers, and hyphens, with a maximum length of 36 characters).
  • Values must follow the pattern: ^[a-zA-Z0-9|\-_ +.@éàèùçâêîôûëïü'/=]{1,1000}$.

Enfuce does not perform any additional validation on these key-value pairs beyond ensuring they match the specified patterns.

These fields are intended for storing data without further processing. If you need to store a complex structure, you can base64 encode the value. The encoded value will be passed as entered, without modifications.

Important: Any usage of these fields should be agreed upon with the manufacturer.

Example:
feeConfigId
string | null

Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.

Required string length: 1 - 36
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"SILVER"