# Manage Card Session
## Manage Card Session
The Manage Card Session API is used to manage card sessions.
## Input Parameters:
| Name | Required | Definition | Comments |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Brand | Y | Format:
Alpha, 3 to 8, lower case letters
| relevant for Operation Types StartCardSessionWithoutCard,StartCardSessionWithoutCardAndClosePreviousSession |
| BrandPhoneNumber | Y | Format: Numeric, 1-15 | relevant for OperationType= StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession |
| CardSessionID | Y | Format: Alphanumeric, 30 | relevant for OperationType= StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, UpdateCardSessionTransferred, GetCardSessionDetails, EndCardSession. This fields is used when there the application cannot use an ID which is not “living” anymore: EndCardSession – for older session (done by CSRPM, for unclosed previous session), StartEscalationSession – for previous escalation, StartSessionWithoutCardAndClosePreviousSession – for previous session, GetCardSessionDetails – for previous session to get details on session (in CSR)) |
| CallTransferred | Y | Format: Y/N (default) | relevant for OperationType= UpdateCardSessionTransferred & CardSessionType=IVR |
| CardSessionType | Y | Format: IVR, CSR, PDP | relevant for all Operation Types |
| Category | C | Format options:
AddressChange
CardExpiredWithFunds
CardExpiredWithPendingACH
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
Verification
VerificationMaxAttemptsReached
WesternUnion
| relevant for OperationType= StartCardSessionWithoutCardAndClosePreviousSession, EndCardSession & CardSessionType=CSR |
| CHPhoneNumber | Y | Format: Numeric, 1-15 | relevant for OperationType= StartCardSessionWithoutCard,StartCardSessionWithoutCardAndClosePreviousSession |
| ContactAddress | N | Format: Alphanumeric,1-30
Description: Required only if Result= Escalated
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| ContactMail | N | Format: Alphanumeric, 5-40
Description:Possible Pattern:
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| ContactName | N | Format: Alphanumeric, 1-40
Description: Required only if Result = Escalated
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| ContactPhone | N | Format: Numeric, 1-15
Description: Required only if Result= Escalated
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| Description | Y | Format: 1-500,
Chars: a-zA-Z0-9 .,#$()/:?-%+\*
| &;@!\~=\_' |
| ID | Y | Format: Numeric, 1-19
require ID based on ID Type value
| relevant for OperationType= UpdateCardInCardSession |
| IDType | C | Format Options:
CardNumber, RPID,DDA, ANY
Required if ID provided
| relevant for OperationType= UpdateCardInCardSession |
| IVRCallGUID | Y | Format: numeric 1-20 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRDuration | Y | Format: numeric, 1-5 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVREndTime | Y | Format: mm/dd/yyyy hh:mm:ss | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRLanguage | Y | Format Options: english/spanish | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRPageHistory | Y | Format: numeric including “/” 1-4000 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRSiteNumber | Y | Format: numeric 1-20 | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRStartTime | Y | Format: mm/dd/yyyy hh:mm:ss | relevant for OperationType= EndCardSession & CardSessionType=IVR |
| IVRTerminationStatus | Y | Format Options:
CallerHungUp/ProviderHungUp/CSRTransfer(Office)/CSRTransfer
| relevant for OperationType= EndCardSession & CardSessionType=IVR |
| OperationType | Y | Format options:
EndCardSession
GetCardSessionDetails
StartCardSessionForPreview
UpdateCardInCardSession
UpdateCardSessionTransferred (for IVR only)
StartCardSessionWithoutCard
StartCardSessionWithoutCardAndClosePreviousSession
StartEscalationCardSession (for CSR only)
StartCardSessionWithCard
CreateEscalationCardSession (for Processes - to e used by DNE feature - future)
| |
| Result | Y | Format options:
Resolved
Cancelled
Escalated
NoVerify
CallNotEnded
CallEnded
ResolvedDelay (internal only and should not be supported by API)
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| VerificationType | C | Options:
ID-Name-Address
ID-Name-DOB
ID-Address-DOB
Name-Address-DOB
Phone-ID-Name
Phone-ID-Address
Phone-ID-DOB
Phone-Name-Address
Phone-Name-DOB
Phone-Address-DOB
Unknown
None
| relevant for OperationType= EndCardSession & CardSessionType=CSR |
| WaiveFee | Y | Format: N (default) /Y
Description: Allows to waive the fee taken for call
| relevant for OperationType= EndCardSession & CardSessionType=IVR |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ActivationDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ActiveHoldsNumber | Format: Numeric, 11
Description:Number of active holds existing for Cardholder
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, EndCardSession |
| UnclosedCardSessionID | Format: Numeric, 19 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UnclosedCardSessionStartDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UnclosedCardSessionStartTime | Format: HH:MM:SS | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ActiveFBECard | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ActiveHoldsTotalAmount | Format: Numeric, 11
Description: Total amount of all active holds existing for Cardholder
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| ActualExpirationDate | Format: Alphanumeric, 12, Month YYYY
Description: example, April 2013
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Brand | Format: Alpha, 1-120 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardAssociation | Format options:
Visa
MasterCard
Star
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardAvailableBalance | Format: Numeric, 11 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| CardDDA | Format: Numeric, 3-16 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| CardFBEDDA | Format: Numeric, 16 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardHolderState | Format options:
V
V-PNS
RNV
NRNV
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, StartCardSessionForPreview |
| CardholderUserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardIssuingBank | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardIssuingBankCode | Format: Alphanumeric, 5 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| CardIssuingBankRoutingNumber | Format: Alphanumeric, 9 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard, GetCardSessionDetails, StartCardSessionForPreview |
| CardSessionID | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| Category | 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
WesternUnion
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| C-B-B | Format: Alphanumeric, “5-2-2” | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| City | Format: Alphanumeric, 20 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Country | Format: ISO Country code. Two characters.
Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DateOfBirth | Format: yyyy-mm-dd
Description: Cardholder must be above 17 years old
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard,StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard |
| Description | Format: Alphanumeric, 1-30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| Dist | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocId | Format: Alphanumeric, 3-16
Description: ID number of the government identification document used (defined in DocType)
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocIssueDate | Format: YYYY-MM-DD
Description: must be before DocExpirationDateConditional value required only when DocType is 'PASS' or 'MCN'
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocIssuer | Format: Alphanumeric, 2
Description: Country/State code.
Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| DocState | Format: Alphanumeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| EarlyAccess | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Email | Format: a-z (upper or lower), numbers, dash and underscore, 5-40
Description: Possible pattern:
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsFeeLess | Format: String, Y or N
Description: Simple yes\no value indicator
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ExpirationDate | Format: MMYY | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Fax | Format: Numeric, 6-10
Description: the fax number.
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FBEEnrollments | Format: Numeric, 2. Number of active FBE Enrollments in statuses Submitted (G), Confirmed (C), Updated (U) and (Enrolled (E) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FeeAmount | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FeeAttempted | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeCollected | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeReversed | Format: Numeric, 10 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeReversedComment | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeReversedReasonCategory | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| FeeWaived | Format: Y/N | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| 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. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FileName | Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! \~ = \_ ' | Not returned | Returned | part of Tag Files/File. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| InboundCallerID | Format: Numeric, 12 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| InvalidPINAttempts | Format: Numeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsPinSet | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsRegistered | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsRetailCard | Format: Y/N
Description: Indicates whether the card is part of a retail pack and is it a retail card
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssueDate | Format: YYYY-MM-DD HH:MM:SS.M | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssuerEmail | Format: a-z (upper or lower), numbers, dash and underscore, 5-40
Description: Possible pattern:
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssuerName | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IssuerPhone | Format: Numeric, 6-15
Description: Phone number
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| IsVerified | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| LastActivityDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| MaxDeclinedTxnsReached | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| MaxPinRetriesReached | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| MiddleInitial | Format: Alpha,1
Description: Middle name char of the cardholder.
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| MobilePhone | Format: Numeric, 6-15
Description: Mobile phone for getting SMS (see IsReceiveSms).
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| OrgName | Format: Alphanumeric, 1-30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| Phone | Format: Numeric, 6-15Description: Phone number | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| Phone | Format: Numeric, 6-15
Description: Phone number
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ProductType | Format: Alphanumeric, 120 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ProgramType | Format: Saving/Commercial/GPR | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| PT | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| PTAllowDifferentShippingAddress | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| PTExpirationDate | Format: MMYY | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| RCIssueWithoutVerification | Format: Y/N | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard. Return the IssueWithoutVerification value of the RC PT of the current Card’ PT (if value is Null, return N) |
| ReplacementMessageType | 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ReplacementStatus | Format options:
CardReplaced
ReplacementCardObsolete
ReplacementCardOrderedFromSameBank
ReplacementCardOrderedFromAnotherBank
ReplacedAnotherCardInSameBank
ReplacedAnotherCardInAnotherBank
ReplacementCardRequired
ReplacementCardRequiredFailure
ToBeReplacedInAnotherBank
ToReplaceCardFromAnotherBank
ToReplaceCardFromSameBank
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Result | Format options:
Resolved
Cancelled
Escalated
NoVerify
CallNotEnded
CallEnded
ResolvedDelay (internal only and should not be supported by API)
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| RPID | Format: Numeric, 1-19 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| SendSMS | Format options:
Enable
Disable
Unspecified
Mail
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ServiceName | Format: A closed list of service names.
Description: Name of service being executed.
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionAgent | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | part of SessionHistory/Session Tag. Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionCallCenter | Format: Alphanumeric, 60 | Not returned | Returned | part of SessionHistory/Session Tag. Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionDate | format: mm/dd/yy | Not returned | Returned | part SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionDuration | Format: Numeric, 5 (xxx.x - minutes.seconds, as 12.4) | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| 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. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionEndDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionEndTime | Format: HH:MM | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| 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. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionStartDate | Format: YYYY-MM-DD | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionStartTime | Format: HH:MM | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SessionTime | Format: hh:mm | Not returned | Returned | part of SessionHistory/Session Tag.Return two last CSR sessions done for CH. Relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| SessionType | Format:
CSR
IVR
CHP
| Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| ShippingAddressLine1 | Format: Alphanumeric, 30
Can contains as well all special characters beside: <, >
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingAddressLine2 | Format: Alphanumeric, 30
Can contains as well all special characters beside: <, >
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingCity | Format: Alpha, 1-20
Can contains as well these special characters: /, -, space, comma, period,
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingState | Format: Alphanumeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| ShippingZIP | Format: Numeric, 5 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| State | Format: Alphanumeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartCardSessionWithoutCard, StartCardSessionWithoutCardAndClosePreviousSession, StartEscalationCardSession, StartCardSessionWithCard,StartCardSessionForPreview |
| 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 | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Store | Format: Alphanumeric, 30 | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| SubBin | Format: Numeric, 3 (of current card) | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| TCFileName | Format: Alphanumeric, 120, including characters "/" , ":" , "." , "" | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UpgradeBalance1 | Format: Numeric, 11 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UpgradeBalance2 | Format: Numeric, 11 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| UserName | Format: Alphanumeric, 6 -30 (including chars: ‘\_’ ,‘-‘) | Not returned | Returned | relevant for OperationType=GetCardSessionDetails |
| VerificationAttempts | Format: Numeric, 2 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| VerificationId | Format: Alphanumeric, 50 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| VerificationStatus | Format options:
VerifiedSSN
VerifiedThirdParty
VerifiedDocumentary
VerifiedByIssuer
SSNVerificationRequired
DocumentaryVerificationRequired
OOWVerificationRequired
Blank
| Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
| Zip | Format: Numeric, 5 | Not returned | Returned | relevant for OperationType=UpdateCardInCardSession, StartEscalationCardSession, StartCardSessionWithCard |
## XML Samples
### Input XML
```json
OperationType=StartCardSessionWithoutCard
testcsr
test_csr
ManageCardSession
1212121212121213
Portal:CSR
CSR
StartCardSessionWithoutCard
123456789
987654321
usf
OperationType=StartCardSessionWithoutCardAndClosePreviousSession
testcsr
test_csr
ManageCardSession
1212121212121213
Portal:CSR
CSR
StartCardSessionWithoutCardAndClosePreviousSession
123456789
987654321
usf
Unknown
Dispute test
b8987f87-7aac-4618-a813-8d8fc927d8b8
OperationType=StartEscalationCardSession
test_csrpm
test_csrpm
ManageCardSession
1212121212121213
Portal:CSR
CSR
StartEscalationCardSession
0999999999998354
"OperationType=UpdateCardInCardSession"
12345678901234560
ManageCardSession
1212121212121213
Portal:CSR
CSR
UpdateCardInCardSession
9999999999998353
RPID
"OperationType=UpdateCardSessionTransferred"
ivr_pm
ivr_pm
ManageCardSession
1212121212121213
Portal:CSR
Y
IVR
UpdateCardSessionTransferred
123456789
"OperationType=StartCardSessionWithCard"
testcsr
test_csr
ManageCardSession
1212121212121213
Portal:CSR
CSR
StartCardSessionWithCard
9999999999998352
RPID
"OperationType=GetCardSessionDetails"
test_csr
test_csr
ManageCardSession
1212121212121213
Portal:CSR
CSR
GetCardSessionDetails
123456789
"OperationType=EndCardSession"
12345678901234569
ManageCardSession
1212121212121213
Portal:csr
EndCardSession
CSR
987654329
Description of Card Session.
Y
Escalated
Dispute
Phone-Name-Address
```
```json
OperationType=EndCardSession
ManageCardSession
62345678901234569
0
StatusOK
OK
2010-06-22 15:15:40
38149115201015064
4
OperationType=StartCardSessionWithCard / StartEscalationCardSession / StartCardSessionWithoutCardAndClosePreviousSession / StartCardSessionWithoutCard
ManageCardSession
0428439b-c290-4444-95d4-46d445626943
0
StatusOK
NA
2014-02-06 11:13:19
5464ee73-8783-4c94-98b8-7ecf18f2d810
9999999999998353
5464ee73-8783-4c94-98b8-7ecf18f2d810
000
03
1270 Broadway
Suite 1207
progress
MasterCard
1999
1234111781298
V
IssuingBanktest900
MB
789123456
New York
US
ACT
1980-01-01
2011-01-01
123456789
2001-01-01
US
SSN
N
qa@praxell.com
0420
2126296232
2
Static
0
Y
Y
Y
2010-06-21 12:55:28.0
Store
2333222333
dev@praxell.com
Y
Data
N
N
2126296040
DevOnly
999
htmls/progress_t_and_c.html
10001
NY
VerifiedByIssuer
April 2020
N
N
9999999999998353
0
0-0-0
OperationType=GetCardSessionDetails
ManageCardSession
38660010201019073
0
StatusOK
OK
2010-07-04 10:19:34
38660010201019073
CSR
jjj
Y
2010-07-01
11:51
2010-07-01
11:59
8.1
Call Not Ended
Call Not Ended
CallCenter
test_csr
CSRViewCHDetailsByCard
CSRCardDetailsValidate
RPCSRGetUpgradeBalance
GetCardReport
ViewList
ResearchCard
ViewList
CSRCallReport
CSRCallDetails
ViewList
SuspendCard
SuspendCard
CSRCallReport
CSRCallDetails
9999999999998074
DevOnly
Store
ProgMngr
200
126
Y
User Error
fee desc
OperationType=UpdateCardSessionTransferred / UpdateCardInCardSession
ManageCardSession
0ffaf7a1-67a8-402f-8877-8ff29f1cc1d3
0
StatusOK
NA
2014-02-05 16:41:38
0ffaf7a1-67a8-402f-8877-8ff29f1cc1d3
```
```json
ManageCardSession
07071612200737105
70166
Invalid ID
Invalid ID
2021-10-01 12:37:50
07071612200737105
```