Skip to main content
POST
/
cards
/
activate
Activate Card
curl --request POST \
  --url https://access.utgl.io/v1/cards/activate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "xeev1she5eegh9daiviethahchoo1muW",
  "cardAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "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]"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
idempotencyKey
string<string>

Unique idempotency key for ensuring exactly-once execution of mutating requests.

Example:

"xeev1she5eegh9daiviethahchoo1muW"

​
cardAccountId
string<uuid>

Card account ID of the card to be locked

​
cardId
string<uuid>

ID of the card to be activated

Response

200 - application/json

Card Activation Successful

​
id
string<uuid>

Card ID of issued card. All card related endpoints require this ID for operation.

​
cardAccountId
string<uuid>

Card account ID of the card

​
xid
string

External identifier, unique across all resources created under this account.

​
xmetadata
object

External metadata

Example:
{
  "key1": "value1",
  "key2": ["value2.1", "value2.2"]
}
​
status
enum<string>
Available options:
active,
pending-issue,
pending-activation,
locked,
suspended,
cancelled
​
embossedName
string

Embossed name on the card

​
network
enum<string>

Card network

Available options:
mastercard
​
product
object

Card product

​
expiryMonth
string

Card expiry month

Example:

9

​
expiryYear
string

Card expiry month

Example:

2030

​
last4
string

Last 4 digits of the card number

​
replacedBy
string

Card id of the card that replaced this card

​
cardLimit
number

Card limit

​
dailyAtmLimit
number

Daily ATM limit

​
dailyPurchaseLimit
number

Daily Purchase limit

​
dailyLimit
number

Daily limit

​
singleTransactionLimit
number

Single transaction limit

​
availableLimit
number

Available limit chargeable on the card, taking into account all limits.

​
cardPresentLimit
number

Card present limit.

​
cardNotPresentLimit
number

Card not present limit.

​
mobile
string

Card cell phone number

​
cardEmail
string<email>

Email address associated with the card

Example:

"[email protected]"