Start Card Session

Start Card Session

The Start Card Session API is used to start CSR/IVR/CHP sessions

Input Parameters:

Name	Required	Definition	Comments
ID	Y	Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber Input should be Card Session ID in case IDType = CardSessionID
IDType	Y	Format options: CardNumber RPID SavingAccount CardSessionID
SessionType	Y	Format: CSR IVR CHP

Output Parameters:

Name	Definition	Failure Case	Success Case	Comments
ActivationDate	Format: YYYY-MM-DD	Not returned	Returned
ActiveFBECard	Format: Y/N	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
CardAssociation	Format options: Visa MasterCard Star	Not returned	Returned
CardAvailableBalance	Format: Numeric, 11	Not returned	Returned
CardDDA	Format: Numeric, 3-16	Not returned	Returned
CardFBEDDA	Format: Numeric, 16	Not returned	Returned
CardHolderState	Format options: V V-PNS RNV NRNV	Not returned	Returned
CardholderUserName	Format: Alphanumeric, 6 -30 (including chars: ‘_’ ,‘-‘)	Not returned	Returned
CardIssuingBank	Format: Alphanumeric, 30	Not returned	Returned
CardIssuingBankCode	Format: Alphanumeric, 5	Not returned	Returned
CardIssuingBankRoutingNumber	Format: Alphanumeric, 9	Not returned	Returned
CardNumber	Format: Numeric, 16	Not returned	Returned
CardSessionID	Format: Alphanumeric, 30	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
C-B-B	Format: Alphanumeric, “5-2-2”	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
DocExpirationDate	Format: YYYY-MM-DD Description: must be after DocIssueDate. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'	Not returned	Returned
DocId	Format: Alphanumeric, 3-16 Description: ID number of the government identification document used (defined in DocType)	Not returned	Returned
DocIssueDate	Format: YYYY-MM-DD Description: must be before DocExpirationDate Conditional value required only when DocType is 'PASS' or 'MCN'	Not returned	Returned
DocIssuer	Format: Alphanumeric, 2 Description: Country/State code. Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'	Not returned	Returned
DocState	Format: Alphanumeric, 2	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
EarlyAccess	Format: Y/N	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
FBEEnrollments	Format: Numeric, 2. Number of active FBE Enrollments in statuses Submitted (G), Confirmed (C), Updated (U) and (Enrolled (E)	Not returned	Returned
FeeAmount	Format: Numeric, 10	Not returned	Returned
FirstName	Format: Alphanumeric, 10	Not returned	Returned
FileCategory	Format Options: Primary Secondary Other Description: Primary files are the following file content types: Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license Secondary files are the following file content types: Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Other files refer to all other file content types (as Third Party)	Not returned	Returned	part of Tag Files/File
FileName	Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! ~ = _ '	Not returned	Returned	part of Tag Files/File
FileContent	Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party The supported characters are: a-z A-Z 0-9 _- / . ' ( ) It is limited to 100 characters	Not returned	Returned	part of Tag Files/File
InvalidPINAttempts	Format: Numeric, 2	Not returned	Returned
IsPinSet	Format: Y/N	Not returned	Returned
IsRegistered	Format: Y/N	Not returned	Returned
IsRetailCard	Format: Y/N Description: Indicates whether the card is part of a retail pack and is it a retail card	Not returned	Returned
IssueDate	Format: YYYY-MM-DD HH:MM:SS.M	Not returned	Returned
IssuerEmail	Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x	Not returned	Returned
IssuerName	Format: Alphanumeric, 30	Not returned	Returned
IssuerPhone	Format: Numeric, 6-15 Description: Phone number	Not returned	Returned
IsVerified	Format: Y/N	Not returned	Returned
LastActivityDate	Format: YYYY-MM-DD	Not returned	Returned
LastName	Format: Alphanumeric, 15	Not returned	Returned
MaxDeclinedTxnsReached	Format: Y/N	Not returned	Returned
MaxPinRetriesReached	Format: Y/N	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
ProductType	Format: Alphanumeric, 120	Not returned	Returned
PTExpirationDate	Format: MMYY	Not returned	Returned
PTAllowDifferentShippingAddress	Format: Y/N	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
SendSMS	Format options: Enable Disable Unspecified Mail	Not returned	Returned
SessionAgent	Format: Alphanumeric, 6 -30 (including chars: ‘_’ ,‘-‘)	Not returned	Returned	part of SessionHistory/Session Tag. Return two last CSR sessions done for CH
SessionCallCenter	Format: Alphanumeric, 60	Not returned	Returned	part of SessionHistory/Session Tag. Return two last CSR sessions done for CH
SessionCategory	Format options: AddressChange CallNotEnded (*will not be show in UI) CardNotReceived CardStatusProblem Card-to-CardTransfer CloseAccountRequest DirectDepositEnrollmentProblem DirectDepositLoadProblem Dispute EarlyAccess FeeComplaint FeeQuestion HoldRelease(only) IncorrectNameorGovtIDorDOB, Lost/StolenCard Other ProblemwithCardReceivedNameNotRight ProblemwithCardReceived-Other Replacement Card Order ReportofPossibleFraud ResearchbySupervisororPM StoreComplaint TransactionorBalanceQuestion TroubleActivatingaCard/SettingaPIN Unknown NewCardFulfillmentFailure Verification ReviewUploadedVerificationDocuments VerificationMaxAttemptsReached WesternUnionType the text for 'Category(Start Card Session)'	Not returned	Returned	part of SessionHistory/Session Tag.Return two last CSR sessions done for CH
SessionDate	format: mm/dd/yy	Not returned	Returned	part SessionHistory/Session Tag.Return two last CSR sessions done for CH
SessionDuration	Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4)	Not returned	Returned	part SessionHistory/Session Tag.Return two last CSR sessions done for CH
SessionResult	Format options: Resolved Cancelled Escalated NoVerify CallNotEnded CallEnded ResolvedDelay (internal only and should not be supported by API)	Not returned	Returned	part of SessionHistory/Session Tag.Return two last CSR sessions done for CH
SessionTime	Format: hh:mm	Not returned	Returned	part of SessionHistory/Session Tag.Return two last CSR sessions done for CH
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
SubBin	Format: Numeric, 3 (of current card)	Not returned	Returned
TCFileName	Format: Alphanumeric, 120, including characters "/" , ":" , "." , ""	Not returned	Returned
UpgradeBalance1	Format: Numeric, 11	Not returned	Returned
UpgradeBalance2	Format: Numeric, 11	Not returned	Returned
VerificationAttempts	Format: Numeric, 2	Not returned	Returned
VerificationId	Format: Alphanumeric, 50	Not returned	Returned
VerificationStatus	Format options: VerifiedSSN VerifiedThirdParty VerifiedDocumentary VerifiedByIssuer SSNVerificationRequired DocumentaryVerificationRequired OOWVerificationRequired Blank	Not returned	Returned
Zip	Format: Numeric, 5	Not returned	Returned

XML Samples

Input XML

<?xml version="1.0" ?>
<PraxellXMLRequest>
<AuthenticationDetails>
    <SessionId>12345678901234567</SessionId>
</AuthenticationDetails> 
    <ClientSourceIP></ClientSourceIP>
<ServiceDetails>
    <ServiceName>StartCardSession</ServiceName>
    <UniqueRequestId>1212121212121213</UniqueRequestId>
</ServiceDetails>
<Origin>
    <OriginType>Portal:CSR</OriginType>
</Origin>
<ServiceParams>
    <ID>9919090000000101</ID>
    <SessionType>CSR</SessionType>
    <IDType>CardNumber</IDType>
</ServiceParams>
</PraxellXMLRequest>

<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>StartCardSession</ServiceName>
        <SessionId>12345678901234567</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2010-06-23 13:49:47</ServiceDate>
        <ServiceId>38234613201049064</ServiceId>
    </ResponseDetails>
    <ResponseParams>
        <ActivationDate></ActivationDate>
        <ActiveFBECard></ActiveFBECard>
        <ActiveHoldsTotalAmount>0</ActiveHoldsTotalAmount>
        <ActualExpirationDate>April 2013</ActualExpirationDate>
        <AddressLine1></AddressLine1>
        <AddressLine2></AddressLine2>
        <Brand></Brand>
        <CardAssociation>Star</CardAssociation>
        <CardAvailableBalance>1999</CardAvailableBalance>
        <CardDDA>1111000235617</CardDDA>
        <CardFBEDDA>1111000235618</CardFBEDDA>
        <CardHolderState>NRNV</CardHolderState>
        <CardholderUserName></CardholderUserName>
        <CardIssuingBank>IssuingBanktest900</CardIssuingBank>
        <CardIssuingBankCode>MB</CardIssuingBankCode>
        <CardIssuingBankRoutingNumber>073972181</CardIssuingBankRoutingNumber>
        <CardNumber></CardNumber>
        <CardSessionID>38234613201049064</CardSessionID>
        <C-B-B></C-B-B>
        <City></City>
        <Country></Country>
        <CardStatus>CII</CardStatus>
        <DateOfBirth></DateOfBirth>
        <DocExpirationDate></DocExpirationDate>
        <DocId></DocId>
        <DocIssueDate></DocIssueDate>
        <DocIssuer></DocIssuer>
        <DocState></DocState>
        <DocType></DocType>
        <EarlyAccess>N</EarlyAccess>
        <Email></Email>
        <ExpirationDate>0413</ExpirationDate>
        <Fax></Fax>
        <FBEEnrollments></FBEEnrollments>
        <FeeAmount></FeeAmount>
        <Files>
          <File>
            <FileCategory>Primary</FileCategory>
            <FileName>a</FileName>
            <FileContent>Passport</FileContent>
          </File>
          <File>
            <FileCategory>Primary</FileCategory>
            <FileName>b</FileName>
            <FileContent>Military ID</FileContent>
          </File>
        </Files>
        <FirstName></FirstName>
        <InvalidPINAttempts>0</InvalidPINAttempts>
        <IsPinSet>N</IsPinSet>
        <IsRegistered>N</IsRegistered>
        <IsRetailCard>Y</IsRetailCard>
        <IssueDate>2008-06-12 04:21:45.0</IssueDate>
        <IssuerName>ProgMngr</IssuerName>
        <IssuerPhone>2333222333</IssuerPhone>
        <IssuerEmail>[e-mail]</IssuerEmail>
        <IsVerified>N</IsVerified>
        <LastActivityDate></LastActivityDate>
        <LastName></LastName>
        <MaxDeclinedTxnsReached>N</MaxDeclinedTxnsReached>
        <MaxPinRetriesReached>N</MaxPinRetriesReached>
        <MiddleInitial></MiddleInitial>
        <MobilePhone></MobilePhone>
        <Phone></Phone>
        <ProductType>Z_Progreso STAR - Low Limit</ProductType>
        <PTExpirationDate></PTExpirationDate>
        <PTAllowDifferentShippingAddress></PTAllowDifferentShippingAddress>
        <SendSMS></SendSMS>
        <ReplacementMessageType></ReplacementMessageType>
        <ReplacementStatus></ReplacementStatus>
        <RPID></RPID>
         <SessionHistory>
            <Session>
                <SessionAgent></SessionAgent>
                <SessionCallCenter></SessionCallCenter>
                <SessionCategory></SessionCategory>
                <SessionDate></SessionDate>
                <SessionDuration></SessionDuration>
                <SessionResult></SessionResult>
                <SessionTime></SessionTime>
            </Session>
            <Session>
                <SessionAgent></SessionAgent>
                <SessionCallCenter></SessionCallCenter>
                <SessionCategory></SessionCategory>
                <SessionDate></SessionDate>
                <SessionDuration></SessionDuration>
                <SessionResult></SessionResult>
                <SessionTime></SessionTime>
            </Session>         </SessionHistory>
        <ShippingAddressLine1></ShippingAddressLine1>
        <ShippingAddressLine2></ShippingAddressLine2>
        <ShippingCity></ShippingCity>
        <ShippingState></ShippingState>
        <ShippingZIP></ShippingZIP>
        <StatusReasonCode></StatusReasonCode>
        <StatusReasonDesc></StatusReasonDesc>
        <SubBin>000</SubBin>
        <State></State>
        <TCFileName></TCFileName>
        <UpgradeBalance1></UpgradeBalance1>
        <UpgradeBalance2></UpgradeBalance2>
        <VerificationAttempts></VerificationAttempts>
        <VerificationStatus></VerificationStatus>
        <VerificationId></VerificationId>
        <Zip></Zip>        
    </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>StartCardSession</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>