CardList

Contains a list of Card objects.

cards object[]

Array [

cardIduuidrequired

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

statusCardStatus (string)required

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.
• DAMAGED - The physical card is damaged but still can be used for online payments.
• LOST - The card is lost and can't be used for operations.

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

expiry object

Card expiry date.

monthintegerrequired

The month of the card expiry date.

Example: 3

yearintegerrequired

The year of the card expiry date.

Example: 2028

binstring

Card bin.

lastFourstring

Card last four digits.

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

customerIdstringrequired

Wallet customer ID.

cardTypeCardType (string)required

Supported card types. Currently we support only VIRTUAL and PHYSICAL

Possible values: [PHYSICAL, VIRTUAL]

programNamestringrequired

Card program name.

currencystringrequired

Card currency code.

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

mobilestring

Mobile phone number used during card creation.

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

deliveryAddress object

The DeliveryAddress object will be used for the PHYSICAL and DIGITAL card delivery. Leave blank for VIRTUAL card.

address1stringrequired

The first line of the address.

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

Example: Tsarigradsko Shose 73

address2string

The second line of the address.

Possible values: <= 30 characters

Example: floor 3

address3string

The third line of the address.

Possible values: <= 30 characters

Example: apartment 43

citystringrequired

Max 30 characters: letters, spaces, hyphen and period

Possible values: <= 30 characters

Example: Sofia

countryCodestringrequired

Country code in ISO-3166 Alpha 2

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

Example: BG

statestring

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

Possible values: <= 3 characters

Example: UT

postalCodestringrequired

For EU customers: maximum length 16

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

minimum 4, maximum 10

Possible values: non-empty and <= 16 characters

Example: 1000

createdDatedate-timerequired

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

accountIdstringrequired

accountId is used for Multi-Currency Accounts.

schemeCardScheme (string)required

Card scheme information.

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

Possible values: [VISA, MC]

activationDatedate-time

When PHYSICAL card has been activated. ISO 8601 format.

isPinSetbooleanrequired

Indicates that the card PIN has been set or not.

externalIdstring

External identifier in merchant system.

cardholderNamestring

Cardholder name.

tokenizations object

Contains a list of Mobile Wallet Tokenizations

mobileWalletTokenizations object[]

Contains information about card enrollments for specific Mobile Wallet

Array [

dpanRefstringrequired

dpan (Device Pan) reference.

Example: DAPLMC00002125433c0c34a2821f4f86866e7576963baf8b

walletIdstring

Wallet Id used only with Google Pay.

Example: NMZlGi8-DezZZKaU06orvl0f

walletTypeMobileWalletType (string)required

Represents the type of a mobile wallet.

Possible values: [GOOGLE_PAY, APPLE_PAY, SAMSUNG_PAY]

statusMobileWalletStatus (string)required

Represents the status of a mobile wallet.

Possible values: [COMPLETED, INITIATED]

]

availableActions object[]

List of available actions performed on a card.

Array [

actionCardAction (string)required

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.
• RESET_PIN_CVV_RETRIES - Reset CVV/PIN verification attempts.

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

]

]

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.

numberOfRecordsinteger

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

Example: 1

limitinteger

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

Example: 10

offsetinteger

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

Example: 0

pageinteger

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

Example: 1

CardList

{
  "cards": [
    {
      "cardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "ACTIVE",
      "expiry": {
        "month": 3,
        "year": 2028
      },
      "bin": "string",
      "lastFour": "string",
      "customerId": "string",
      "cardType": "PHYSICAL",
      "programName": "string",
      "currency": "string",
      "mobile": "string",
      "deliveryAddress": {
        "address1": "Tsarigradsko Shose 73",
        "address2": "floor 3",
        "address3": "apartment 43",
        "city": "Sofia",
        "countryCode": "BG",
        "state": "UT",
        "postalCode": "1000"
      },
      "createdDate": "2024-07-29T15:51:28.071Z",
      "accountId": "string",
      "scheme": "VISA",
      "activationDate": "2024-07-29T15:51:28.071Z",
      "isPinSet": true,
      "externalId": "string",
      "cardholderName": "string",
      "tokenizations": {
        "mobileWalletTokenizations": [
          {
            "dpanRef": "DAPLMC00002125433c0c34a2821f4f86866e7576963baf8b",
            "walletId": "NMZlGi8-DezZZKaU06orvl0f",
            "walletType": "GOOGLE_PAY",
            "status": "COMPLETED"
          }
        ]
      },
      "availableActions": [
        {
          "action": "ACTIVATE"
        }
      ]
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}