Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Cards

Retrieve a Card

get/api/v1/cards/{publicToken}

Path parameters

publicTokenstring required

Response

Success

cardType'Physical' | 'Virtual' | 'MasterVirtual'

Form factor of the card.

publicTokenstring nullable

Public Token of the Card

statusstring 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

designIdstring nullable

DesignId set at time of Card Generation

parentCardinteger nullable

Public token of parent card

childCardsinteger[] nullable

Array of child public tokens

siblingCardsinteger[] nullable

Array of sibling cards' public tokens. (Cards which share the same parent.) <br> Applicable if the card is a child card.

freetext1string nullable

Additional fulfilment data.

freetext2string nullable

Additional fulfilment data.

isSingleUseboolean nullable

Create card single use

isNonReloadableboolean nullable

Create card non reloadable

networkSharingOptOutboolean nullable

Network automatic data sharing

language3dsstring nullable

Gets or sets the language3ds.

programManagerIDinteger

Program Manager Id

programManagerCodestring nullable

Program Manager Code

oobAppUrlstring nullable

Gets or sets the oobAppUrl.

urlstring nullable

QR code url or delivery id

isMultiFxboolean nullable

MultiFx Card Identifier

isMfxPrimaryboolean nullable

Identifier to identify the card is MFX Primary or not.

isoLanguagestring nullable

Card holder preferred language (2-character ISO 639-1 code)

Example response

{
  "cardType": "Virtual",
  "publicToken": "4321567890",
  "status": "Active",
  "cardStatusCode": "00",
  "cardStatusDescription": "00 (Active)",
  "balance": {
    "currencyCode": "GBP",
    "cardBalance": 1000,
    "availableBalance": 1000
  },
  "cardHolder": {
    "title": "Mr",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "1963-11-22",
    "mobile": "07471234567",
    "email": "john.smith@example.com"
  },
  "cardProduct": {
    "scheme": "Example Scheme",
    "product": 45,
    "ehiMode": 2
  },
  "3DS": [
    {
      "defaultCredentials": [
        {
          "type": "OTPSMS",
          "value": "07723849948"
        }
      ],
      "fallbackCredentials": {
        "type": "OTPSMS",
        "value": "07723849948"
      }
    }
  ],
  "parentCard": 987654321054321,
  "siblingCards": [
    987654322454321,
    987651221054320
  ]
}