Get Card Details

GET 
/api/v2/cards/:id

Retrieve details for a bank card based on the provided card ID.

Request

Path Parameters

id The card id to get details forrequired

Responses

200

Successful Response

application/json

Schema

Schema

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.

Example (from schema)

{
  "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.717Z",
  "balance": {
    "available": 0,
    "spent": 0,
    "pending": 0
  },
  "user": {
    "id": "string",
    "nickname": "string",
    "email": "string"
  }
}

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...