# 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.
| 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:
| 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
```json
test_pm
test_pm
;
GetCardDetails
1212121212121213
ExtAPI
Dist1
9999999999998068
CardNumber
12.1
14.2
Y
GroupName
```
```json
GetCardDetails
37996606200818094
0
StatusOK
NA
2008-09-21 06:18:47
37996606200818094
03
120865
February 2011
1270 Broadway
Suite 1207
1999
1234111778452
// (sorted by by file content group and then by file name)
IssuingBanktest900
MB
789123456
ACT
ACT
V
New York
US
1980-01-01
123456789
SSN
qa@praxell.com
0211
2126296232
Static
Y
Y
2010-07-20 18:25:02.0
Store
Y
Data
2126296040
DevOnly
1360
DevOnly
CardExpirationDate
9999999999998068
NY
10001
10001
10001
```
```json
GetCardDetails
07071612200737105
70021
Invalid Card Id
Invalid Card Id
2021-10-01 12:37:50
07071612200737105
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://apidocs.juicefin.com/apis/card-status-and-management/get-card-details.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.