Search Cardholder

The Search Cardholder API produces a list of cardholder matching the search criteria, including card details.

The FirstName and LastName parameters are converted based on the following rules: i. All * characters are replaced with % ii. All ? characters are replaced with _ iii. All characters that are NOT a-zA-Z0-9_% are removed

Input Parameters:

Name

Required

Definition

Comments

CardNumber

Format: Numeric, 4

relevant only if Indicator Type=CardPT or CardDOB or NameCard or CardDocID or CardDist

DateOfBirth

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

relevant only if Indicator Type=CardDOB or DocIdDOB or NameDOB

DistributorName

Format: Alphanumeric, 1-30

relevant only if Indicator Type=NameDist or CardDocID or CardDist

DocId

Format: Alphanumeric, 4

relevant only if Indicator Type=DocIdDOB

FirstName

Format: Alphanumeric and * , 2-20

relevant only if Indicator Type=NameDOB or NameCard or NameDist

IndicatorType

Format: DocIdDOB – allow to search cardholder by DocId & Date of Birth fields NameDOB – allow to search cardholder by First Name or Last Name & Date of Birth fields CardDOB – allow to search cardholder by CardNumber & Date of Birth fields CardPT – allow to search cardholder by CardNumber & PT fields NameCard - allow to search cardholder by First Name or Last Name & card (4 last) fields NameDist - allow to search cardholder by First Name or Last Name & Dist fields CardDocID - - allow to search cardholder by card (last 4) & DocID (last 4) fields CardDist - allow to search cardholder by card (last 4) & Dist fields Description: Provide indication on which of the multiple options to execute

LastName

Format: Alphanumeric and * , 2-20

relevant only if Indicator Type=NameDOB or NameCard or NameDist

Format: Alphanumeric, 30

relevant only if Indicator Type=CardPT

Output Parameters:

Name

Definition

Failure Case

Success Case

Comments

AddressLine1

Format: Alphanumeric, 30

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

AddressLine2

Format: Alphanumeric, 30

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

CardBalance

Format: Numeric, 11

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

CardExpirationDate

Format: MMDD

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

CardNumber

Format: Numeric, 16

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

CHState

Format options: NRNV RNV V-PNS V

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

City

Format: Alphanumeric, 20

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

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

Returned as part of SearchResults/Cardholder tag

CurrentStatus

Format options: CII LOCKED_CII LOCK ACT SPND LST STLN CC

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

DateOfBirth

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

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

DocId

Format: Alphanumeric, 4

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

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

Returned as part of SearchResults/Cardholder tag

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

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

Fax

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

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

FirstName

Format: Alphanumeric, 10

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

MiddleInitial

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

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

LastName

Format: Alphanumeric, 15

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

Phone

Format: Numeric, 6-15 Description: Phone number

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

Format: Alphanumeric, 30

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

PTFriendlyName

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

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

State

Format: Alphanumeric, 2

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

Status

Format: ACTIVE (default) ALL

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

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

Returned as part of SearchResults/Cardholder tag

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

Returned as part of SearchResults/Cardholder tag

TotalRows

Format: Alphanumeric, 5

Not returned

Returned

Zip

Format: Numeric, 5

Not returned

Returned

Returned as part of SearchResults/Cardholder tag

XML Samples

Input XML

<?xml version="1.0" ?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <UserName></UserName>
    <UserPassword></UserPassword>
    <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <UniqueRequestId>920994</UniqueRequestId>
    <ServiceName>SearchCardholder</ServiceName>
  </ServiceDetails>
  <Origin>
    <OriginType>ExtAPI</OriginType>
  </Origin>
  <ServiceParams>
    <CardNumber></CardNumber>
    <IndicatorType>NameDOB</IndicatorType>
    <DateOfBirth>1980-01-01</DateOfBirth>
    <FirstName>Dan</FirstName>
    <LastName>Kraut</LastName>
  </ServiceParams>
</PraxellXMLRequest>

<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>SearchCardholder</ServiceName>
        <SessionId>40433713200954111</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2009-11-19 13:54:16</ServiceDate>
        <ServiceId>40433713200954111</ServiceId>
    </ResponseDetails>
    <ResponseParams>
       <TotalRows>6</TotalRows>
       <SearchResults>
       <Cardholder>
          <FirstName>testSearch</FirstName>
          <MiddleInitial>a</MiddleInitial>
          <LastName>cardholders</LastName>
          <AddressLine1>gdxfxvx</AddressLine1>
          <AddressLine2>vcxvcx</AddressLine2>
          <City>vxvcx</City>
          <State>CO</State>
          <Zip>353544534</Zip>
          <Country>US</Country>
          <Phone>235432543253</Phone>
          <Fax></Fax>
          <DateOfBirth>1980-01-01 00:00:00.0</DateOfBirth>
          <Email>gfdgd@gffgfdg.fgd</Email>
          <DocId>100000000000</DocId>
          <DocType>DL</DocType>
          <CardNumber></CardNumber>
          <Status>ACT</Status>
          <StatusReasonCode></StatusReasonCode>
          <StatusReasonDesc>NA</StatusReasonDesc>
          <PT>1020</PT>
          <PTFriendlyName>Progreso Prepaid MasterCard (408) Flag - Sp</PTFriendlyName>
          <CHState>V-PNS</CHState>
       </Cardholder>
       <Cardholder>
          <FirstName>testSearch</FirstName>
          <MiddleInitial>a</MiddleInitial>
          <LastName>cardholders</LastName>
          <AddressLine1>vvvpppeee</AddressLine1>
          <AddressLine2>mnmnkd</AddressLine2>
          <City>nmnmdk</City>
          <State>CO</State>
          <Zip>353544534</Zip>
          <Country>US</Country>
          <Phone>235432543253</Phone>
          <Fax></Fax>
          <DateOfBirth>1980-01-01 00:00:00.0</DateOfBirth>
          <Email>gfdgd@gffgfdg.fgd</Email>
          <DocId>100000000000</DocId>
          <DocType>DL</DocType>
          <CardNumber></CardNumber>
          <Status>ACT</Status>
          <StatusReasonCode></StatusReasonCode>
          <StatusReasonDesc>NA</StatusReasonDesc>
          <PT>1020</PT>
          <PTFriendlyName>Progreso Prepaid MasterCard (408) Flag - Sp</PTFriendlyName>
          <CHState>V-PNS</CHState>
       </Cardholder>
       </SearchResults>
    </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>SearchCardholder</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>

PreviousReturn To Inventory NextSuspend Card

Last updated 2 months ago