Card Management (CMP)

Create a card

post

The Create Card Operation allows clients to register a card into the Card Management Platform (CMP) using a simple API call. This card object is linked to a specific account, supporting account-level management and visibility. Each card is uniquely identified by a persistent Card ID, which does not change, even if updates are made to the underlying card data. This Approach enables businesses to manage card-related features like tokenization and account updates in a centralized, consistent way. CMP ensures secure handling and logical grouping of cards under customer accounts, offering a scalable and organized card management experience.

PAN and Card Verification Code (CVC) tokens/aliases generated by VGS will be included as part of the response and the actual CVC can be included securely as part of a transaction. Only PCI-Compliant clients will be able to view the actual CVC, while non-PCI-Compliant clients will only be able to view an indicator that CVC was added as part of the transaction. Find more information on CVC here.

Authorizations
Body

The card information.

Responses
201

Card created

application/vnd.api+json
post
POST /cards HTTP/1.1
Host: sandbox.vgsapi.com
Authorization: Bearer JWT
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 210

{
  "data": {
    "attributes": {
      "pan": "4111111111111111",
      "pan_alias": "tok_sandbox_hhyPgvvdFfFGBnyi73TfFu",
      "cvc": "123",
      "cvc_status": "active",
      "cvc_alias": "tok_sandbox_5XK62B8G2i1mTwoGR5o4tL",
      "exp_month": 4,
      "exp_year": 28
    }
  }
}
{
  "data": {
    "id": "CRDecqZp3xRgXU3TFmtcDdzQs",
    "type": "cards",
    "attributes": {
      "pan": "4111111111111111",
      "cvc_status": "active",
      "pan_alias": "tok_sandbox_hhyPgvvdFfFGBnyi73TfFu",
      "cvc": "123",
      "cvc_alias": "tok_sandbox_5XK62B8G2i1mTwoGR5o4tL",
      "bin": "411111",
      "first8": "41111111",
      "last4": "1111",
      "exp_month": 5,
      "exp_year": 28,
      "card_fingerprint": "6TeSCB16LtyifEAmY2goxYfSk5sALriXpefzzxh29xhu",
      "capabilities": [
        "network-tokens",
        "card-updates"
      ],
      "created_at": "2025-08-01T00:00:00Z",
      "updated_at": "2025-08-01T00:00:00Z"
    },
    "meta": {
      "token_type": "pan"
    }
  },
  "metadata": {
    "observability": {
      "trace_id": "2d137f00cc53f5a9265f3b40402f7892",
      "client_id": "ACHwLNAA4-jc_testvault-sY8MF",
      "vault_id": "tnt9hg3iiwy",
      "account_id": "ACTrKr34UF7YyvbVPwcWqXHWn",
      "fingerprint": "KCxZx3kkeXF9xnJvyzJHRwx5ycyrDNgzAXk8K15E5BpyuHmpTR5qfBRgzAvrzurFdtM"
    }
  }
}

Get a card

get

The Get Card API allows clients to retrieve details for a specific card using its unique Card ID. This includes core card metadata and any associated account updater or network token information, if applicable. This endpoint is useful for verifying enrollment status, accessing the current state of a card, or reviewing the card's lifecycle attributes. It provides a comprehensive snapshot of the card and its current relationships within CMP.

Authorizations
Path parameters
card_idstringRequired
Query parameters
includestringOptional

Comma-delimited list of fields to include in the response.

Responses
200

Item requested by ID

application/vnd.api+json
get
GET /cards/{card_id} HTTP/1.1
Host: sandbox.vgsapi.com
Authorization: Bearer JWT
Accept: */*
{
  "data": {
    "id": "CRDecqZp3xRgXU3TFmtcDdzQs",
    "type": "cards",
    "attributes": {
      "pan": "4111111111111111",
      "cvc_status": "active",
      "pan_alias": "tok_sandbox_hhyPgvvdFfFGBnyi73TfFu",
      "cvc": "123",
      "cvc_alias": "tok_sandbox_5XK62B8G2i1mTwoGR5o4tL",
      "bin": "411111",
      "first8": "41111111",
      "last4": "1111",
      "exp_month": 5,
      "exp_year": 28,
      "card_fingerprint": "6TeSCB16LtyifEAmY2goxYfSk5sALriXpefzzxh29xhu",
      "capabilities": [
        "network-tokens",
        "card-updates"
      ],
      "created_at": "2025-08-01T00:00:00Z",
      "updated_at": "2025-08-01T00:00:00Z"
    },
    "meta": {
      "token_type": "pan"
    }
  },
  "metadata": {
    "observability": {
      "trace_id": "2d137f00cc53f5a9265f3b40402f7892",
      "client_id": "ACHwLNAA4-jc_testvault-sY8MF",
      "vault_id": "tnt9hg3iiwy",
      "account_id": "ACTrKr34UF7YyvbVPwcWqXHWn",
      "fingerprint": "KCxZx3kkeXF9xnJvyzJHRwx5ycyrDNgzAXk8K15E5BpyuHmpTR5qfBRgzAvrzurFdtM"
    }
  }
}