Get Card Report
Get Card Report
The Get Card Report API produces the relevant response, including card general details and a list of transactions.
There is a possibility to get the results in paging mode (used mainly for UI). When using paging, NextPosition will return the number of the first transaction on the next page. For example: in case and Count=5 , first Get Card Report call will return 5 first transaction and NextPosition=5 (0 based). there is a need to send this value for the second Get Card Report call.
Specific information regarding paging mode used with GetHolds=Y:
Holds returns ONLY for the first result set (position =0) and ALL holds are always returns independent of the Count value provided.
If first result set contains holds, at least 1 transaction will be returned in addition to holds.
If first result set contains holds, TransactionNumber parameter will return results size minus holds count (at least 1 transaction will be returned).
Input Parameters:
CardNumber
C
Format: Numeric, 16
Mutually exclusive with ID. Deprecated (use ID/ID Type)
Count
N
Format: Numeric 1-100 Description: Number of transactions to be retrieved. Used for pagination & better use of server resources.
CountMaxHoldsToReturn
N
Format: Numeric, 3, By default 0 Description: Define the maximum of holds to be returned by API in case and GetHolds=Y.
FromDate
N
Format: YYYY-MM-DD Description: The default value is Today's date
GetHolds
N
Format: N(default)/Y Description: GetCardReport API provides (among other transactions) the list of authorizations & purchases done by the cardholder. Every authorization may be a Hold. The Get Card Report will return these authorizations as well (if not filtered out) but without hold information as hold expiration date. In order to be able to get only the active holds, it is possible to define the relevant Get Card Report API’ parameter GetHolds as Y. Then, the Get Card Report API will provide all active holds. When a hold has expired the API response will no longer list that hold. Holds will be returned with Praxell code containing “P85” (PP85DS). In order to avoid showing “pending transactions” twice (as authorization and as hold), it is possible to filter out authorization Praxell codes and to get holds. In this way, the cardholder see his pending transactions (holds) and his settlements (non-authorization transactions)
if GetLinkedCardsHistory=Y and GetHolds=Y, the holds will be returned for the default account' current card
GetLinkedCardsHistory
N
Format: N(default)/Y
Return history of all cards linked to the required card
ID
C
Format: Numeric, 1-19 Description: Input should be RPID in case IDType = RPID Input should be Card Number in case IDType = CardNumber
Mutually exclusive with CardNumber. Required if IDType is provided
IDType
C
Format options: CardNumber RPID SavingAccount
relevant only for ID parameter
Order
N
Format: Closed list of values. ASC DESC Description: Indicates whether the query should be executed in ascending or descending order (Date is the order field).
Position
N
Format: Numeric, 1-4, >0 Description: Number of position in list of values\records. For example, if Position=30 and Count=5, then the Response Transaction List begins with top (30+5) transactions. In the XML Response only records 31, 32, 33, 34 and 35 from that Transaction List are included. Default 0.
ResponseType
N
Format: Closed list of values. All (default) Trx Details BalanceOnly Description: Operation response type
SearchText
N
Format: Alphanumeric, 1-30 Description: Text to search.
ToDate
N
Format: YYYY-MM-DD Description: the date should be after FromDate
TransactionCodes
C
Format: 6 characters Description:List of Praxell codes. Each Praxell code is 6 characters. Filter list of required transaction codes to filter by: Praxell code, Praxell Code, etc or PP0DS, PP01DS, etc.
TransactionsCodeGroup
O
Format: Praxell code group name (e.g. PINSuspiciousTransactions, CHTXN (used by GetCardDetails, CHP, IVR Interface), Savings (used by CHP, IVR Interface for savings statement))Allow to return of transactions with Praxell codes belong to this group
TransactionCodesMode
C
Format: Included /Excluded Description: Requires TransactionCodes parameter
Output Parameters:
AccountNumber
Format: Alphanumeric, 17 Description: Processor Account Number
Not returned
Returned
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
ActiveHoldsUnreturnedNumber
Format: Numeric, 2 Description: Total amount of all active holds which have not be returned 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
Amount
Format: Numeric, 1-9 Description: The amount is in cents.
Not returned
Returned
Returned as part of TransactionList/Transaction tag
ApprovalCode
Format:Alphanumeric, 8
Not returned
Returned
Returned as part of TransactionList/Transaction tag
AvailableBalance
Format: Numeric, 11
Not returned
Returned
Returned as part of TransactionList/Transaction tag
Brand
Format: Alpha, 1-120
Not returned
Returned
CardAssociation
Format options: Visa MasterCard Star
Not returned
Returned
CardAvailableBalance
Format: Numeric, 11
Not returned
Returned
CardBalance
Format: Numeric, 11
Not returned
Returned
Returned as part of TransactionList/Transaction tag
CardDDA
Format: Numeric, 3-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, 4 Description: XXXX-XXXX-XXXX-1234
Not returned
Returned
Returned as part of TransactionList/Transaction tag
CardStatus
Format Options: O (Open, for ACT and SPND card statuses), C (Close, for all other card statuses)
Not returned
Returned
CardType
Format: Primary/Secondary (field called CardType in APIs)
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
Currency
Format: Alphanumeric, 3
Not returned
Returned
Returned as part of TransactionList/Transaction tag
CurrentStatus
Format options: CII LOCKED_CII LOCK ACT SPND LST STLN CC
Not returned
Returned
Date
Format: YYYY-MM-DD
Not returned
Returned
Returned as part of TransactionList/Transaction tag
DateOfBirth
Format: yyyy-mm-dd Description: Cardholder must be above 17 years old
Not returned
Returned
Description
Format: Alphanumeric, 1-30
Not returned
Returned
Returned as part of TransactionList/Transaction tag
DisplayDescription
Format: Alphanumeric, 200
Not returned
Returned
Returned as part of TransactionList/Transaction tag
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
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
FirstName
Format: Alphanumeric, 10
Not returned
Returned
HoldsBalance
Format: Numeric, 11
Not returned
Returned
Returned as part of TransactionList/Transaction tag
HoldExpirationDate
Format: MM-DD-YYYY Description: The date the holds expired
Not returned
Returned
Returned as part of TransactionList/Transaction tag
InvalidPINAttempts
Format: Numeric, 2
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
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
IssuerName
Format: Alphanumeric, 30
Not returned
Returned
IssuerUser
Format: Alphanumeric, 6-30
Not returned
Returned
IsVerified
Format: Y/N
Not returned
Returned
LastName
Format: Alphanumeric, 15
Not returned
Returned
MaxDeclinedTxnsReached
Format: Y/N
Not returned
Returned
MaxPinRetiresReached
Format: Y/N
Not returned
Returned
MCC
Format: Alphanumeric, 4
Not returned
Returned
Returned as part of TransactionList/Transaction tag
MCCDescription
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
NextPosition
Format: Numeric, 2
Not returned
Returned
Phone
Format: Numeric, 6-15 Description: Phone number
Not returned
Returned
PINTriesExceeded
Format: Y/N
Not returned
Returned
PostedBalance
Format: Numeric, 11 (balance after transaction was done, before fees were taken)
Not returned
Returned
Returned as part of TransactionList/Transaction tag
PrimaryVerificationUploadedDocuments
The number of uploaded primary verification documents. Format: numeric,2
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
ProgramType
Format: Saving/Commercial/GPR
Not returned
Returned
PTExpirationDate
Format: MMYY
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
ResponseType
Format: approved/declined
Not returned
Returned
Returned as part of TransactionList/Transaction tag
RPID
Format: Numeric, 1-19
Not returned
Returned
Returned as part of TransactionList/Transaction tag
SecondaryVerificationUploadedDocuments
The number of uploaded secondary verification documents. Format: numeric,2
Not returned
Returned
ServiceId
Format: Exact 17 chars. Description: A unique identifier which represents a transaction in the Praxell system.
Not returned
Returned
Returned as part of TransactionList/Transaction tag
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
TCFileName
Format: Alphanumeric, 120, including characters "/" , ":" , "." , ""
Not returned
Returned
TermAddress
Format: Alphanumeric, 30
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TermCity
Format: Alphanumeric, 25
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TermCountry
Format: Alphanumeric, 3
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TermNameLocation
Format: Alphanumeric, 25
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TermOwner
Format: Alphanumeric, 25
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TermState
Format: Alphanumeric, 3
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TermZIP
Format: Alphanumeric, 10
Not returned
Returned
Returned as part of TransactionList/Transaction tag
Time
Format: HH:MM:SS
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TotalTransactionNumber
Format: Numeric, 2
Not returned
Returned
TransactionCode
Format: Alphanumeric, 6
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TransactionDescription
Format: Alphanumeric, 100
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TransactionId
Format: Alphanumeric, 50
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TransactionNumber
Format: Numeric, 2
Not returned
Returned
TransactionOrigin
Format: Alphanumeric, 1
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TransactionType
Format: List of values: Credit, Debit, Auth, Info Description: provide the type of the transaction
Not returned
Returned
Returned as part of TransactionList/Transaction tag
TxnAmount
Format: Numeric, 11
Not returned
Returned
Returned as part of TransactionList/Transaction tag
UniqueRequestId
Format: Alphanumeric, 30
Not returned
Returned
Returned as part of TransactionList/Transaction tag
Zip
Format: Numeric, 5
Not returned
Returned
XML Samples
Input XML
Last updated