Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Cards

Retrieve Card Status

get/api/v1/cards/{publicToken}/status

Path parameters

publicTokenstring required

Response

Success

statusstring nullable

String representation of the GPS.API.Core.Models.Response.V1.Cards.GetStatusResponse.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 Card Status Code

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

Descriptive status of the Card

Example response

{
  "status": "Active",
  "cardStatusCode": "00",
  "cardStatusDescription": "00 (Active)"
}