Skip to main content
GET
/
cards
Get Cards
curl --request GET \
  --url https://access.utgl.io/v1/cards \
  --header 'Authorization: Basic <encoded-value>'
{
  "prevPageToken": "<string>",
  "nextPageToken": "<string>",
  "cards": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cardAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "xid": "<string>",
      "xmetadata": {
        "key1": "value1",
        "key2": [
          "value2.1",
          "value2.2"
        ]
      },
      "status": "active",
      "embossedName": "<string>",
      "network": "mastercard",
      "product": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "imageUrl": "<string>",
        "cardType": "<string>",
        "cardImageDetails": {
          "cardOrientation": "LANDSCAPE",
          "cardWidth": "<string>",
          "cardHeight": "<string>",
          "cardNameFontSize": "<string>",
          "cardNameFontWeight": "<string>",
          "cardNameLineHeight": "<string>",
          "cardNameLetterSpacing": "<string>",
          "cardNamePosition": "<string>",
          "cardNameCoordinates": [
            123
          ],
          "cardNameColor": "<string>"
        }
      },
      "expiryMonth": 9,
      "expiryYear": 2030,
      "last4": "<string>",
      "replacedBy": "<string>",
      "cardLimit": 123,
      "dailyAtmLimit": 123,
      "dailyPurchaseLimit": 123,
      "dailyLimit": 123,
      "singleTransactionLimit": 123,
      "availableLimit": 123,
      "cardPresentLimit": 123,
      "cardNotPresentLimit": 123,
      "mobile": "<string>",
      "cardEmail": "[email protected]",
      "cardSpendingToday": "10000"
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

cardAccountId
string
required

Card Account ID

cardId
string

Card ID

cardEmbossedName
string

Card Embossed Name

status
enum<string>

Card Status

Available options:
PENDING_ACTIVATION,
ACTIVE,
LOCKED,
SUSPENDED,
CANCELLED
cardProductId
string

Card Product ID

cardLast4
string

The Last 4 Digits of Card Number

pageSize
number

Limits the number returned items Some collections have a upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If no page size is provided, the collection will determine the page size itself.

Required range: x >= 1
pageToken
string
Example:

"aWVHZWV5OVgK"

Response

200 - application/json

OK

prevPageToken
string

Opaque page token to retrieve next or previous set of results.

nextPageToken
string

Opaque page token to retrieve next or previous set of results.

cards
object[]