--- title: "Retrieve a Card" method: GET path: "/api/v1/portal/cards/{publicToken}" tags: ["Thredd portal cards"] --- # Retrieve a Card `GET /api/v1/portal/cards/{publicToken}` ## Request - Base URL: `https://cardsapi-uat-pub.globalprocessing.net` - URL: `https://cardsapi-uat-pub.globalprocessing.net/api/v1/portal/cards/{publicToken}` - Auth: OAuth 2 - Client credentials - Token URL: `https://uatists.globalprocessing.net/connect/token` scopes: `readWrite` ## Path parameters - `publicToken` string, required ## Response `200` Success - GetCardResponse: Response class for a request for Card details - `cardType` 'Physical' | 'Virtual' | 'MasterVirtual': Form factor of the card. - `publicToken` string, nullable: Public Token of the Card - `status` string, nullable: String representation of the GPS.API.Core.Models.Response.V1.Cards.GetCardResponse.CardStatusCode enum. - `cardStatusCode` '00' | '04' | '05' | '41' | '43' | '46' | '54' | '57' | '59' | '62' | '63' | '70' | '83' | '98' | '99' | 'G1' | 'G2' | 'G3' | 'G4' | 'G5' | 'G6' | 'G7' | 'G8' | 'G9', nullable: Two character alphanumeric CardStatusCode - `cardStatusDescription` '00 (Active)' | '04 (Capture Card)' | '05 (Do Not Honour)' | '41 (Lost Card)' | '43 (Stolen Card)' | '46 (Closed Account)' | '54 (Card Expired)' | '57 (Transaction Not Permitted To Cardholder)' | '59 (Suspected Fraud)' | '62 (Restricted Card)' | '63 (Security Violation)' | '70 (Cardholder To Contact Issuer)' | '83 (Card Destroyed)' | '98 (Refund Given To Customer)' | '99 (Card Voided)' | 'G1 (Short Term Debit Block)' | 'G2 (Short Term Full Block)' | 'G3 (Long Term Debit Block)' | 'G4 (Long Term Full Block)' | 'G5 (Gps Protect Short Term Debit Block)' | 'G6 (Gps Protect Short Term Full Block)' | 'G7 (Gps Protect Long Term Debit Block)' | 'G8 (Gps Protect Long Term Full Block)' | 'G9 (Ivr Lost Stolen Block)', nullable: Description of the CardStatusCode - `balance` BalanceResponse: Card balance. - `currencyCode` string, nullable: Currency code (3-letter format) - `cardBalance` number, double: Actual balance of the Card (including blocked amount) - `pendingAmount` number, double: Blocked Amount (i.e. part of available balance which cannot be used) - `availableBalance` number, double: Available Balance - `cardDetails` CardDetails: Card details. - `customerReference` string, nullable: Customer reference (account number). - `fullNameOnCard` string, nullable: Embossed name on card. - `maskedPan` string, nullable: Masked PAN, only populated for non encrypted card - `startDate` string, nullable: Start date. Format YYYY-MM-DD. - `expiryDate` string, nullable: Expiry date. Format YYYY-MM-DD. - `clearPan` string, nullable: Clear pan, only populated for encrypted card - `cvv` string, nullable: Cvv, only populated for encrypted card - `activationDate` string, nullable: Activation date. Universal datetime Format. - `gpsExpiryDate` string, nullable: GPS Expiry date. Format YYYY-MM-DD. - `cardHolder` CardHolder: Cardholder details. - `title` string, nullable: Title of the cardholder. - `firstName` string, required: First name of the cardholder. - `middleName` string, nullable: Middle name of cardholder - `lastName` string, required: Last name of the cardholder. - `dateOfBirth` string, required: Date of Birth of the cardholder. Format YYYY-MM-DD. - `mobile` string, nullable: Mobile number of cardholder. - `email` string, nullable: Email address of the cardholder. - `cardProduct` CardProduct: Card product details. - `scheme` string, nullable: Scheme name. - `product` integer: Product ID. - `productShortName` string, nullable: Product short name - `productName` string, nullable: Gets or sets the name of the product. - `ehiMode` integer: EHI mode for the product type. - `networkId` integer: Gets or sets the network identifier. - `subBinLow` integer, nullable - `subBinHigh` integer, nullable - `controlGroups` ControlGroups: Ids of the Card control groups (zero for no group set). - `limitsGroup` integer, nullable: Identifier of the card limits group. - `usageGroup` integer, nullable: Identifier of the card usage group. - `recurringFeeGroup` integer, nullable: Identifier of the card recurring fee group. - `webServiceFeeGroup` integer, nullable: Identifier of the card Web Service fee Group - `authFeeGroup` integer, nullable: Identifier of the card Auth fee group. - `mccGroup` integer, nullable: Identifier of the card MCC group. - `cardLinkageGroup` integer, nullable: Identifier of the card linkage group. - `calendarGroup` integer, nullable: Identifier of the card calendar group. - `fxGroup` integer, nullable: Identifier of the card FX group. - `paymentTokenUsageGroup` integer, nullable: Identifier of the card payment token usage group. - `cardAcceptorAllowList` integer, nullable: Identifier of the the card acceptor allow list. - `cardAcceptorDisallowList` integer, nullable: Identifier of the the card acceptor disallow list. - `limitedNetworkGroup` integer, nullable: Identifier of the the card limited network group. - `3DS` CardCredential[], nullable: 3DS Credentials - `configuration` string, nullable: The type of credential: RDX or Batch File. - `defaultCredentials` Credential[], nullable: List of default credentials, will be a single item unless default authentication type is 'CHOICE' and there are multiple credentials associated with the card. - `type` string, nullable: Type of credential: Email, SMS, Biometric etc. - `value` string, nullable: The credential value, determined by its type, ie email address for email, mobile number for SMS etc. - `id` integer: ID of the credential. - `fallbackCredentials` Credential: 3DS Credential information. - `type` string, nullable: Type of credential: Email, SMS, Biometric etc. - `value` string, nullable: The credential value, determined by its type, ie email address for email, mobile number for SMS etc. - `id` integer: ID of the credential. - `designId` string, nullable: DesignId set at time of Card Generation - `parentCard` integer, nullable: Public token of parent card - `childCards` integer[], nullable: Array of child public tokens - `siblingCards` integer[], nullable: Array of sibling cards' public tokens. (Cards which share the same parent.)
Applicable if the card is a child card. - `address` Address: Address details. - `addressLine1` string, required: First line of the address. - `addressLine2` string, nullable: Second line of the address. - `addressLine3` string, nullable: Third line of the address. - `city` string, nullable: City name. - `state` string, nullable: State. - `county` string, nullable: County, region or province. - `postCode` string, required: Postcode / Zip code of the address. - `country` string, required: Country of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK). - `fulfilment` Address: Address details. - `addressLine1` string, required: First line of the address. - `addressLine2` string, nullable: Second line of the address. - `addressLine3` string, nullable: Third line of the address. - `city` string, nullable: City name. - `state` string, nullable: State. - `county` string, nullable: County, region or province. - `postCode` string, required: Postcode / Zip code of the address. - `country` string, required: Country of residence. This is represented as a 3-letter alphanumeric ISO country code (e.g. GBR for UK). - `freetext1` string, nullable: Additional fulfilment data. - `freetext2` string, nullable: Additional fulfilment data. - `isSingleUse` boolean, nullable: Create card single use - `isNonReloadable` boolean, nullable: Create card non reloadable - `networkSharingOptOut` boolean, nullable: Network automatic data sharing - `cardAcceptorIds` CardAcceptorIdListResponse: List of Allowed/Disallowed Card Acceptors in the List. - `allowCardAcceptors` string[], nullable: List of Allowed Card Acceptors in the List. - `disallowCardAcceptors` string[], nullable: List of Disallowed Card Acceptors in the List. - `language3ds` string, nullable: Gets or sets the language3ds. - `programManagerID` integer: Program Manager Id - `programManagerCode` string, nullable: Program Manager Code - `oobAppUrl` string, nullable: Gets or sets the oobAppUrl. - `url` string, nullable: QR code url or delivery id - `isMultiFx` boolean, nullable: MultiFx Card Identifier - `isMfxPrimary` boolean, nullable: Identifier to identify the card is MFX Primary or not. - `isoLanguage` string, nullable: Card holder preferred language (2-character ISO 639-1 code) ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Server Error ## Changes - **2026-11-03** `a5b5e4fdcf41`: 1 info - endpoint added [Operation history](https://skmtc.dev/thredd/apis/core-cards/changes/api/v1/portal/cards/:publicToken/get.md) --- [API](https://skmtc.dev/thredd/apis/core-cards.md) - [All operations](https://skmtc.dev/thredd/apis/core-cards/llms.txt) - [OpenAPI document](https://skmtc.dev/thredd/apis/core-cards/revisions/a5b5e4fdcf41?raw)