Get Card List

POST 
/api/v2/cards/list

Get Card List

Request

application/json

Body

required

limit Limit

Default value: 10

Maximum number of records to return.

offset Offset

The offset from where to start fetching cards.

filters object
Filter criteria for selecting wallets.
textFilter Textfilter
Free text search filter by wallet name or code.
userIds object[]
Array [
anyOf
MOD1
string
MOD2
string
]
binCodes string[]
statuses BankCardStatus[]
Possible values: [ACTIVE, FROZEN, BLOCKED]
countryCodes string[]
createdAtFrom date-time
Default value: 1970-01-01T00:00:00Z
Filter by the starting date (inclusive), filter is applied to createdAt field (Card scheme).
createdAtTo date-time
Default value: 2024-05-06T06:27:47Z
Filter by the ending date (inclusive), filter is applied to createdAt field (Card scheme).
walletIds object[]
Array [
anyOf
MOD1
string
MOD2
string
]
binPurposes BinPurposeEnum[]
Possible values: [CARDS_VIRTUAL, SHARED_BALANCE_VIRTUAL_CARDS]
isFavorite Isfavorite
sortBy BankCardSortField[]

Possible values: [BALANCE, SPENT, CARD_NAME, BIN_CODE, USER_NICKNAME, CREATED_AT]

orderBy SortOrder[]

Possible values: [ASC, DESC]

Responses

200

Successful Response

application/json

Schema

Schema

items object[]required
Array of cards objects.
Array [
status BankCardStatusrequired
Possible values: [ACTIVE, FROZEN, BLOCKED]
An enumeration.
cardName Cardname
limits object
single object
amount Amount
The limit amount.
daily object
amount Amount
The limit amount.
monthly object
amount Amount
The limit amount.
autoTopUp object
thresholdAmount Thresholdamountrequired
The balance threshold to trigger an automatic top-up.
topUpAmount Topupamountrequired
The amount to be automatically topped up when the threshold is reached.
isFavorite Isfavoriterequired
wallet_id uuid
id object required
anyOf
MOD1
string
MOD2
string
maskedPan Maskedpanrequired
bin objectrequired
code Coderequired
BIN code
countryCode Countrycoderequired
ISO country code
currencyCode Currencycoderequired
ISO currency code
provider object
An enumeration.
billingAddress Billingaddressrequired
Billing address of the bank card.
paymentServices PaymentService[]
Possible values: [APPLE_PAY, GOOGLE_PAY, SAMSUNG_PAY]
List of supported tokenized payment services. If the list is empty, the BIN doesn't support tokenization.
merchants string[]
purposes BinPurposeEnum[]
Possible values: [CARDS_VIRTUAL, SHARED_BALANCE_VIRTUAL_CARDS]
fees objectrequired
issue objectrequired
feeAmount Feeamountrequired
unit Unitrequired
authorization object[]
Array [
minAmount Minamountrequired
maxAmount Maxamount
feeAmount Feeamountrequired
unit Unit
Default value: USD
]
decline objectrequired
feeAmount Feeamountrequired
unit Unitrequired
zeroAuth objectrequired
feeAmount Feeamountrequired
unit Unitrequired
createdAt date-timerequired
balance object
available Availablerequired
spent Spentrequired
pending Pendingrequired
user objectrequired
id object required
Id of the card holder.
anyOf
MOD1
string
MOD2
string
nickname Nicknamerequired
Nickname or alias of the card holder.
email Emailrequired
Email of the card holder.
]
totalCount Totalcountrequired

Total number of cards corresponding to the filters.

Example (from schema)

{
  "items": [
    {
      "status": "ACTIVE",
      "cardName": "string",
      "limits": {
        "single": {
          "amount": 1000
        },
        "daily": {
          "amount": 1000
        },
        "monthly": {
          "amount": 1000
        }
      },
      "autoTopUp": {
        "thresholdAmount": 1000,
        "topUpAmount": 1000
      },
      "isFavorite": true,
      "wallet_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": "string",
      "maskedPan": "string",
      "bin": {
        "code": "string",
        "countryCode": "string",
        "currencyCode": "string",
        "billingAddress": "string",
        "paymentServices": [
          "APPLE_PAY"
        ],
        "merchants": [
          "string"
        ],
        "purposes": [
          "CARDS_VIRTUAL"
        ],
        "fees": {
          "issue": {
            "feeAmount": 0,
            "unit": "string"
          },
          "authorization": [
            {
              "minAmount": 0,
              "maxAmount": 0,
              "feeAmount": 0,
              "unit": "USD"
            }
          ],
          "decline": {
            "feeAmount": 0,
            "unit": "string"
          },
          "zeroAuth": {
            "feeAmount": 0,
            "unit": "string"
          }
        }
      },
      "createdAt": "2024-05-09T10:22:47.714Z",
      "balance": {
        "available": 0,
        "spent": 0,
        "pending": 0
      },
      "user": {
        "id": "string",
        "nickname": "string",
        "email": "string"
      }
    }
  ],
  "totalCount": 0
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD1
string
MOD2
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...