Get a card token

POST 
/api/cards/:cardId/pan-token

Generate a card token to enable the subsequent retrieval of the card's sensitive details including full PAN, expiry, CVV2 and embossedName.

Refer to the fetching secure card information guide for more information.

The callback URL responds with an object containing the card's sensitive details.

{
  "cvv2": "442",
  "pan": "1234123412345678",
  "expiry": "202501",
  "embossedName": "DOE/JOHN"
}

Request

Path Parameters

cardId stringrequired

ID of card for which to obtain a token

Responses

200

Successful operation

application/json

Schema

Schema

tokenId stringrequired

One-time use token for card detail retrieval

callbackUrl stringrequired

One-time URL which can be called to retrieve the card's secure details.

This URL requires no authentication.

Example (from schema)

{
  "tokenId": "1E2426184B3676720F36E43A22649AFF-1000041153",
  "callbackUrl": "https://api-sec.immersve.com/api/cards/secure?tokenId=1E2426184B3676720F36E43A22649AFF-1000041153"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

Loading...