CardList

Contains a list of Card objects.

cards

object[]

Array [

cardId uuidrequired

Card id is a unique identifier for a specific card. It will be used for most operations to the prepaid card.

status CardStatus (string)required

Possible values: [ACTIVE, PENDING, CANCELLED, SUSPENDED, APPLIED, DIGITAL, REJECTED, LOCKED, EXPIRED, ISSUED]

Contains information about the different card statuses.

• ACTIVE - Card can be used for payments.
• PENDING - Intermediate status before issuing a card, while performing additional validations.
• CANCELLED - The card is canceled and can't be used for any kind of operation. The status is (IRREVERSIBLE).
• SUSPENDED - The status is changed from CS (Customer Service) representative or due to customer actions like (wrong activation info).
• APPLIED - Intermediate status for a card that is stuck due to technical reasons.
• DIGITAL - PHYSICAL card that is active and can be used for online payments only, but it is not yet delivered to the client, and it is not activated.
• REJECTED - Card is rejected due to technical / validation reasons.
• LOCKED - Card is locked by the customer and can't be used for payments.
• EXPIRED - Card is expired.
• ISSUED - The status indicates that the customer has successfully applied for a PHYSICAL card, but the card is not yet activated and can't be used for payments.

expiry

object

Card expiry date.

month integerrequired

The month of the card expiry date.

year integerrequired

The year of the card expiry date.

bin string

Card bin.

lastFour string

Possible values: >= 4 characters and <= 4 characters

Card last four digits.

customerId stringrequired

Wallet customer ID.

cardType CardType (string)required

Possible values: [PHYSICAL, VIRTUAL]

Supported card types. Currently we support only VIRTUAL and PHYSICAL

programName stringrequired

Card program name.

currency stringrequired

Possible values: >= 3 characters and <= 3 characters

Card currency code.

mobile string

Possible values: Value must match regular expression ^\+\d+\s?\d{1,16}$

Mobile phone number used during card creation.

deliveryAddress

object

The DeliveryAddress object will be used for the PHYSICAL card delivery. It must be null in case of VIRTUAL card

address1 stringrequired

Possible values: >= 4 characters and <= 40 characters

The first line of the address.

address2 string

Possible values: <= 30 characters

The second line of the address.

address3 string

Possible values: <= 30 characters

The third line of the address.

city stringrequired

Possible values: <= 30 characters

Max 30 characters: letters, spaces, hyphen and period

countryCode stringrequired

Possible values: >= 2 characters and <= 2 characters

Country code in ISO-3166 Alpha 2

state string

Possible values: <= 3 characters

The field is mandatory for US Customers: 2 to 3 characters state or province abbreviation. Example: "UT"

postalCode stringrequired

Possible values: non-empty and <= 16 characters

For EU customers: maximum length 16

For US customers: Pattern: ^[a-zA-Z0-9-\ ]*$

minimum 4, maximum 10

createdDate date-timerequired

Card created date in ISO 8601 format. Example: 2022-10-04T11:14:47.596Z

accountId stringrequired

accountId is used for Multi-Currency Accounts.

scheme CardScheme (string)required

Possible values: [VISA, MC]

Card scheme information.

• VISA - VISA
• MC - Mastercard The scheme is derived from the card PAN.

activationDate date-time

When PHYSICAL card has been activated. ISO 8601 format.

isPinSet booleanrequired

Indicates that the card PIN has been set or not.

externalId string

External identifier in merchant system.

tokenizations

object

Contains a list of Mobile Wallet Tokenizations

mobileWalletTokenizations

object[]

Contains information about card enrollments for specific Mobile Wallet

Array [

dpanRef stringrequired

dpan (Device Pan) reference.

walletId string

Wallet Id used only with Google Pay.

walletType MobileWalletType (string)required

Possible values: [GOOGLE_PAY, APPLE_PAY, SAMSUNG_PAY]

Represents the type of a mobile wallet.

status MobileWalletStatus (string)required

Possible values: [COMPLETED, INITIATED]

Represents the status of a mobile wallet.

]

availableActions

object[]

List of available actions performed on a card.

Array [

action CardAction (string)required

Possible values: [ACTIVATE, CANCEL, UNLOCK, LOCK, SHOW_DETAILS, SHOW_PIN, SET_PIN]

Represents name of the action that can be performed on a card.

• ACTIVATE - Activates newly received card. Can be used only for PHYSICAL card
• CANCEL - Cancel card for all the operations. The status is IRREVERSIBLE.
• UNLOCK - Unlocks locked card.
• LOCK - Locks the card for all operations. It is reversible by UNLOCK action.
• SHOW_DETAILS - Shows sensitive card details (PAN, CVV, expiry date).
• SHOW_PIN - Shows pin of the card.
• SET_PIN - Updates pin of the card.

]

]

meta

object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

• limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
• offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecords integer

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

limit integer

This is the requested number of records to be returned per page.

offset integer

This is the requested starting position of the response, where 0 is the first record.

page integer

This is the page of records on which the lookup starts. The starting page is 1.