Get Card Details

Get Card Details

The Get Card Details API provides all required information about the card and its cardholder.

Input Parameters:

Name
Required
Definition
Comments

CVV

N

Format: Numeric, 3

GetHoldsBalance

N

Format: Y/N (Default = N)

ID

Y

Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber

IDType

N

Format options: CardNumber RPID SavingAccount

Default=CardNumber

Latitude

N

Format: Alphanumeric, Comma, Dot, "-", 1-8 (can be 40.71435) Description: Latitude can range between 0 and 90 degrees, and can be north or south. (Zero degrees latitude is neither north nor south.) The North Pole is at 90° north latitude; the South Pole is at 90° south latitude. The Equator is at zero degrees latitude.

Longitude

N

Format: Alphanumeric, Comma, Dot, "-", 1-9 (can be -74.00597) Description: Longitude can range between 0 and 180 degrees, and can be east or west. (Zero and 180 degrees longitude are neither east nor west.) The Greenwich Meridian, which passes through the United Kingdom, is at zero degrees longitude (unlike zero degrees latitude, the zero point for longitude is just an arbitrary choice, made for historical reasons).

GetExtraCardDetails

N

Format: Y/N (default) allow to return transactions belonging to praxell codes group: CHTXN

GetGroupsFiles

N

Format: Names of Groups (containing list of file contents). If parameter provided, the API will return all cardholder' files having a file content existing in this File Group. It support as well multiple groups (group, group, ..) The supported characters are: a-z A-Z 0-9 _- . , It is limited to 100 characters

GetUserDefinedParams

N

Format: N (default)/Y. if value is Yes, API provide all user defined data (UserDefined1-15)

OrgId

N

Format: Alphanumeric, 20 Value can be multiple org_id’s split by commas

for internal uses

Output Parameters:

Name
Definition
Failure Case
Success Case
Comments

ActivationDate

Format: YYYY-MM-DD

Not returned

Returned

ActiveHoldsNumber

Format: Numeric, 11 Description:Number of active holds existing for Cardholder

Not returned

Returned

ActiveHoldsTotalAmount

Format: Numeric, 11 Description: Total amount of all active holds existing for Cardholder

Not returned

Returned

ActualExpirationDate

Format: Alphanumeric, 12, Month YYYY Description: example, April 2013

Not returned

Returned

AddressLine1

Format: Alphanumeric, 30

Not returned

Returned

AddressLine2

Format: Alphanumeric, 30

Not returned

Returned

Brand

Format: Alpha, 1-120

Not returned

Returned

CardAvailableBalance

Format: Numeric, 11

Not returned

Returned

CardDDA

Format: Numeric, 3-16

Not returned

Returned

CardIssuingBank

Format: Alphanumeric, 30

Not returned

Returned

CardIssuingBankCode

Format: Alphanumeric, 5

Not returned

Returned

CardIssuingBankRoutingNumber

Format: Alphanumeric, 9

Not returned

Returned

CardStatus

Format options: "ACT" (Active) "CC" (Close) "CII" (Card In Inventory) "LOCK_CII" (Locked Card In Inventory) "LOCK" (Locked) "LST" (Lost) "SPLT" (Spoilt) "SPND" (Suspended) "STLN" (Stolen) Description: All application cards statuses (as ACT, SPND, etc)

Not returned

Returned

CardStatusId

Format options: ACT, CC, CII, LOCK_CII, LOCK, LST, SPLT, SPND, STLN

Not returned

Returned

CHState

Format options: NRNV RNV V-PNS V

Not returned

Returned

City

Format: Alphanumeric, 20

Not returned

Returned

Country

Format: ISO Country code. Two characters. Description: Based on ISO 3166-1 alpha-2 list. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Not returned

Returned

DateOfBirth

Format: yyyy-mm-dd Description: Cardholder must be above 17 years old

Not returned

Returned

DocId

Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)

Not returned

Returned

DocType

Format options: SSN PASS UDL MCN INMATE Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PASS - Passport number, 'UDL' – US Drivers license number,'MCN' - Matricula consular ,INMATE.

Not returned

Returned

Email

Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x

Not returned

Returned

ExpirationDate

Format: MMYY

Not returned

Returned

Fax

Format: Numeric, 6-10 Description: the fax number.

Not returned

Returned

FBEDDA

Format: Numeric, 16

Not returned

Returned

FileName

Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! ~ = _ '

Not returned

Returned

part of Tag Files/File

FirstName

Format: Alphanumeric, 10

Not returned

Returned

IsPinSet

Format: Y/N

Not returned

Returned

IsReceiveSms

Format options: Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's) Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's) Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's) Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails) Description:Defines if the cardholder gets an SMS/Mail.

Not returned

Returned

IsRegistered

Format: Y/N

Not returned

Returned

IssueDate

Format: YYYY-MM-DD HH:MM:SS.M

Not returned

Returned

IssuerName

Format: Alphanumeric, 30

Not returned

Returned

IsVerified

Format: Y/N

Not returned

Returned

LastName

Format: Alphanumeric, 15

Not returned

Returned

MiddleInitial

Format: Alpha,1 Description: Middle name char of the cardholder.

Not returned

Returned

MobilePhone

Format: Numeric, 6-15 Description: Mobile phone for getting SMS (see IsReceiveSms).

Not returned

Returned

Phone

Format: Numeric, 6-15 Description: Phone number

Not returned

Returned

ProductTypeName

Format: Alphanumeric, 1-120 Description: Each sub program in Praxell consists of one or more product types. A product type is a set of attributes that are applied to the cards that belong to this product type. The ProductTypeName field is the name of the product used when creating and issuing cards.

Not returned

Returned

PT

Format: Alphanumeric, 30

Not returned

Returned

PTExpirationDate

Format: MMYY

Not returned

Returned

PTFriendlyName

Format: Alphanumeric, 1-120 Description: Product Type known name.

Not returned

Returned

ReplacementMessageType

Format options: ToBeReplacedInAnotherBankForVerifiedCH ToBeReplacedInAnotherBankForRNVCH PTExpirationDate CardExpirationDate ReplacementCardOrderedFromAnotherBank ReplacementCardOrderedFromSameBank ReplacedAnotherCardInAnotherBank

Not returned

Returned

ReplacementStatus

Format options: CardReplaced ReplacementCardObsolete ReplacementCardOrderedFromSameBank ReplacementCardOrderedFromAnotherBank ReplacedAnotherCardInSameBank ReplacedAnotherCardInAnotherBank ReplacementCardRequired ReplacementCardRequiredFailure ToBeReplacedInAnotherBank ToReplaceCardFromAnotherBank ToReplaceCardFromSameBank

Not returned

Returned

RPID

Format: Numeric, 1-19

Not returned

Returned

ShippingAddressLine1

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

Not returned

Returned

ShippingAddressLine2

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

Not returned

Returned

ShippingCity

Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,

Not returned

Returned

ShippingState

Format: Alphanumeric, 2

Not returned

Returned

ShippingZIP

Format: Numeric, 5

Not returned

Returned

State

Format: Alphanumeric, 2

Not returned

Returned

StatusReasonCode

Format options: CardExpired CardReplaced CIPException CloseCardForDispute Closed ClosedByPM Deceased Excess-Chargeback InsufficientKYC InvalidArrowEyefiles NegativeWriteOff POBox PrePurge PurgedCard PurgedFailedAtProcessor ReadyToPrint Arbitration ByPM CIPExceptionSus Confirmed Fraud Dispute Lost Lost-Stolen Other Poss Fraud Poss Fraud Warm Address Poss Fraud Warm Source IP PrimaryCardSuspension ProcSuspectedFraudWithNotes ReDisputed ReplaceFailure ReplacementCardRequired Represented Stolen StoreError SuspectedFraud TransactionCompletenessException UnactivatedCard UnactivatedReplacementCard Violation

Not returned

Returned

StatusReasonDesc

Format options: Card Expired Card Replaced CIP Exception Close Card Submited for Dispute Closed Closed By PM Deceased Excess-Chargeback Insufficient KYC Invalid Arrow Eye files Negative Write-off POBox Pre Purge Purged Purged Failed At Processor Ready To Print Arbitration By PM CIP Exception Confirmed Fraud Dispute Lost Lost - Stolen Other Poss Fraud Poss Fraud Warm Address Poss Fraud Warm Source IP Primary Card Suspension Processor Suspected Fraud With Notes Re-disputed Replace Failure Replacement Card Required Represented Stolen Store error Suspected Fraud Suspected Fraud Transaction Completeness Exception Unactivated Card Unactivated Replacement Card Violation

Not returned

Returned

UserDefined1

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined2

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined3

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined4

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined5

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined6

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined7

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined8

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined9

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined10

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined11

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined12

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined13

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined14

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

UserDefined15

Format: Chars: a-zA-Z0-9 .,#$()/:?-%+*&;@!~=_' Size: 255

Not returned

Returned

Zip

Format: Numeric, 5

Not returned

Returned

CardholderUsername

Format: Alphanumeric, 6 -30 (including chars: ‘_’ ,‘-‘)

Not returned

Returned

Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)

ReplacedCard

Not returned

Returned

Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)

ProgramType

Format: Saving/Commercial/GPR

Not returned

Returned

Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)

CardType

Format: Primary/Secondary (field called CardType in APIs)

Not returned

Returned

Field relevant to the default account' current card (Returned in DefaultAccountCurrentCardDetails XML tag)

XML Samples

Input XML

<?xml version="1.0" ?>
<PraxellXMLRequest>
  <AuthenticationDetails>
       <UserName>test_pm</UserName>
       <UserPassword>test_pm</UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <ServiceName>GetCardDetails</ServiceName>
    <UniqueRequestId>1212121212121213</UniqueRequestId>
  </ServiceDetails>
  <Origin>
     <OriginType>ExtAPI</OriginType>
  </Origin>
 <ServiceParams>
    <OrgId>Dist1</OrgId>        
    <ID>9999999999998068</ID>        
    <IDType>CardNumber</IDType>
    <Latitude>12.1</Latitude>
    <Longitude>14.2</Longitude>
    <GetUserDefinedParams>Y</GetUserDefinedParams>
    <GetGroupsFiles>GroupName</GetGroupsFiles>
 </ServiceParams>
</PraxellXMLRequest>  
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>GetCardDetails</ServiceName>
        <SessionId>37996606200818094</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2008-09-21 06:18:47</ServiceDate>
        <ServiceId>37996606200818094</ServiceId>
    </ResponseDetails>
    <ResponseParams>
        <ActivationDate></ActivationDate>
        <ActiveHoldsNumber>03</ActiveHoldsNumber>
        <ActiveHoldsTotalAmount>120865</ActiveHoldsTotalAmount>
        <ActualExpirationDate>February 2011</ActualExpirationDate>
        <AddressLine1>1270 Broadway</AddressLine1>
        <AddressLine2>Suite 1207</AddressLine2>
        <Brand></Brand>
        <CardAvailableBalance>1999</CardAvailableBalance>
        <CardDDA>1234111778452</CardDDA>
        <ShippingAddressLine1></ShippingAddressLine1>
        <ShippingAddressLine2></ShippingAddressLine2>
        <ShippingCity></ShippingCity>
        <ShippingState></ShippingState>
        <ShippingZIP></ShippingZIP>
        <UserDefined1></UserDefined1>
        <UserDefined2></UserDefined2>
        <UserDefined3></UserDefined3>
        <UserDefined4></UserDefined4>
        <UserDefined5></UserDefined5>
        <UserDefined6></UserDefined6>
        <UserDefined7></UserDefined7>
        <UserDefined8></UserDefined8>
        <UserDefined9></UserDefined9>
        <UserDefined10></UserDefined10>
        <UserDefined11></UserDefined11>
        <UserDefined12></UserDefined12>
        <UserDefined13></UserDefined13>
        <UserDefined14></UserDefined14>
        <UserDefined15></UserDefined15>
        <Files>
               <File>
                  <FileName></FileName> // (sorted by by file content group and then by file name)
             </File>
        </Files>
        <CardIssuingBank>IssuingBanktest900</CardIssuingBank>
        <CardIssuingBankCode>MB</CardIssuingBankCode>
        <CardIssuingBankRoutingNumber>789123456</CardIssuingBankRoutingNumber>
        <CardStatus>ACT</CardStatus>
        <CardStatusId>ACT</CardStatusId>
        <CHState>V</CHState>
        <City>New York</City>
        <Country>US</Country>
        <DateOfBirth>1980-01-01</DateOfBirth>
        <DocId>123456789</DocId>
        <DocType>SSN</DocType>
        <Email>qa@praxell.com</Email>
        <ExpirationDate>0211</ExpirationDate>
        <Fax>2126296232</Fax>
        <FBEDDA></FBEDDA>
        <FirstName>Static</FirstName>
        <IsPinSet>Y</IsPinSet>
        <IsReceiveSms></IsReceiveSms>
        <IsRegistered>Y</IsRegistered>
        <IssueDate>2010-07-20 18:25:02.0</IssueDate>
        <IssuerName>Store</IssuerName>
        <IsVerified>Y</IsVerified>
        <LastName>Data</LastName>
        <MiddleInitial></MiddleInitial>
        <MobilePhone></MobilePhone>        
        <Phone>2126296040</Phone>
        <ProductTypeName>DevOnly</ProductTypeName>
        <PT>1360</PT>
        <PTExpirationDate></PTExpirationDate>
        <PTFriendlyName>DevOnly</PTFriendlyName>
        <ReplacementMessageType>CardExpirationDate</ReplacementMessageType>
        <ReplacementStatus></ReplacementStatus>
        <RPID>9999999999998068</RPID>
        <State>NY</State>
        <StatusReasonCode></StatusReasonCode>
        <StatusReasonDesc></StatusReasonDesc>
        <Zip>10001</Zip>
        <CardholderUsername>10001</CardholderUsername>
        <ReplacedCard>10001</ReplacedCard>
        <ProgramType></ProgramType>
        <CardType></CardType>
    </ResponseParams>
</PraxellXMLResponse>
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>GetCardDetails</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70021</StatusCode>
    <StatusName>Invalid Card Id</StatusName>
    <StatusDescription>Invalid Card Id</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>
PreviousGet Card BalanceNextGet Card Holder Spend Limits

Last updated