Introduction to APIs

API General Message Layout and Requirements

API Message Format

About the Response to the User

About Response Time

Back Office Web Access

Currency Amounts and Conversion Instructions

PIN Encryption

Alternatives to Using Card Number in the CardAPI

API User Credentials

CardHolder API’s

Change Card Status – Function 004

Change Card PIN – Function 005

Deposit to Card Number – Function 007

Message Response Lookup – Function 008

View Statement Details by Card Number – Function 010

Validate PIN – Function 012

Set Card PIN – Function 022

Get Card Status – Function 023

Get Card Account Balance – Function 024

Cardholder Fees – Function 030

Adjustment – Function 031

Card Linking – Function 032

Card Inquiry – Function 033

Cash Out – Function 034

Card to Card Transfer – Function 035

Update Cardholder – Function 036

PIN Reset – Function 037

PIN Request – Function PINRequest

View Statement Details by Account Number – Function 039

Unlock Bad PIN Tries – Function 040

Set Condition Check for Existing Cardholder – Function SetCondCheck

Manage MCC Blocks – Function MCCBlock

Set Cardholder Level Limit – Function CardLimit

Get Configurable Card Limits – Function GetCardLimits

OFAC Check – Function 056

View Statement Details by Card Number (V2) – Function 070

3DS Enrolment Control – Function THREEDS

3DS Whitelist Management – Function Manage3DSWhitelist

Card Risk Level API Calls

Update Card Risk Level – Function = UpdateRiskLevel

Get Card Risk Level – Function = GetRiskLevel

Instant Card Issue – Function = InstantCardIssue

Specialized Financial Transactions

Validate Cardholder Verification Data – Function ValidateCVV2

Get Dynamic CVV (CVV3) – Function GetCVV3

General Web APIs

Change Password – ChangePswd

Message Heart Beat – Function 025

Wallet API Functions

Create Wallet for Existing Cardholder – Function CreateCardholderWallet

Create Wallet Multi-Currency Card Purse – Function CreateCardPurse

Retrieve Card Purse Identification from Wallet – Function GetCardPurses

Multi-currency Card Purse to Purse Transfer – Function PurseFundsTransfer

Processing Codes


Transaction Processing Codes

Response Codes

Card/Account Type Definitions

API Error Codes


View Statement Details by Card Number (V2) – Function 070

Function 070, View Statement Details by a PAN or ALT ID, gives you a summary or history of transactions over a given period. All transactions that occurred to that card number between the start and the end dates are returned. The results are returned using XML for this API call.

The biggest difference between function 070 and 010 is the effect of the currency format display. Function 010 defaults to two decimal places on the implied decimal value when returning. Function 070 takes the currency into account and displays the appropriate value for implied decimal conversions. Currencies with 3 decimal places and 0 decimal places will now return correctly formatted in regard to the cardholders currency.

By default, function 070 will suppress authorization transactions when there is a matching settlement.

Inputs Description Required Data Type
FunctionID 070 Y
P1 PAN OR ALT ID Y (16,19) numeric
P2 Start Date Y date (i.e., 01/01/2001)
P3 End Date Y date (i.e., 01/01/2001)
P4 GMT N alpha (Z, T, Y)
P5 First Row N numeric (starting index of result set)
P6 Last Row N numeric (ending index of result set)
ViewAll=Y Returns all transactions N
ViewAll=N Returns only settled transactions N
Outputs Description
XML The data will be passed back in a well-formed XML document. The error code processing will be contained in the P1 node that contains two attributes errnumber and errdescription. Therefore, if the errnumber attribute is equal to “000” the document will contain a “cardholderstatementdetails” node; otherwise, it will not.
Response XML:
Element Name Description
Date Date/time of the transaction.
CardNumber Card number associated with the transaction.
TransactionType Transaction type code.
MTI Message type identifier.
STN System Trace Audit Number.
TermID Unique identifier of the of a card acceptor terminal.
AuthNum Authorization identification number.
RecType Record Type. Private use field which varies by network.
TransactionOrigin Identifies if this transaction comes from an ATM (‘A’) or POS (‘P’)
Description A short description of what kind of transaction this is.
Amount Implied decimal amount of the transaction.
fee Implied decimal amount of any fee charged for this transaction.
atmfee Fee applied to the cardholder by the ATM in an implied decimal amount.
availablebalance Available balance on the card after the transaction was processed.
ledgerbalance Ledger balance on the card after the transaction was processed.
clientid Client ID.
termnamelocation Location of the terminal.
termowner Owner of the terminal.
termcity City of the terminal.
termstate State of the terminal.
termcountry Country of the terminal.
mcc Merchant category code of the transaction.
surcharge Surcharge applied in the cardholder billing currency in an implied decimal
rspcode Response code. See section 10.2 for a detailed list of response codes.
processor Identifies which system processed the transaction.
issuerfee Issuer fee.
origtransamt Local currency amount.
convrrate Currency conversion rate used if this transaction required a currency
termcurrency Terminal currency.
currency Cardholder currency.
origholdamt Original holding amount.
acqinst Acquiring Institution Identification Code.
cardacceptoridcode Identifying code of the card acceptor.
Example: Statement Details Request by           PAN OR ALT ID by
dassignedtome&FUNC=070&MSGID=00001646767884116&P1= PAN OR
Example: Statement Details Response by            PAN OR ALT ID
<api func=”070″>
<p1 errnumber=”0000″
errdescription=”” />
<cardpan account=”6153587000002932″
startdate=”01/01/2008″ enddate=”06/06/2008″
reportdate=”2005/10/08 10:27 AM”>
<date>05/02/2008 11:42:27 AM</date>
<TermID />
<description>Deposit funds</description>
<termowner />
<termcity />
<termstate />
<termcountry />
tor idcode>**
<date>05/02/2008 11:49:22 AM</date>
<TermID />
< RecType>7801</RecType>
<description>Deposit funds</description>
<termowner />
<termcity />
<termstate />
<termcountry />
ptor idcode>
Interpreting transaction history and details responses data:
1. The first two numeric’s in the transaction type identify the transaction (see below)
2. The ‘transaction origin’ identifies if the transaction is a “P”OS transaction, or “A”TM transaction Ifthe transaction type starts with a 15 it is a debit, if it starts with a 27 it is a credit.