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

Statements

Transaction Processing Codes

Response Codes

Card/Account Type Definitions

API Error Codes

FAQs

Response Codes

Code Description
000 Approved
001 Approved, verification only – VISA only
002 Partial Approval
003 Approved – VIP
009 Force Post unmatched – requires follow up [STAR only]
011 Refer to card issuer [STAR only]
012 Refer to card issuer – special conditions [STAR only]
048 PIN Change Required
049 Account not Open/Inactive Card
050 Invalid MTI
051 Expired card (expiration date check)
052 Allowable number of PIN tries exceeded
053 Invalid Transaction
055 Transaction not permitted to Cardholder
056 Incorrect PIN
057 Pickup card – Lost/Stolen
058 Declined Card Status
059 Restricted Card
060 Invalid Account number – no such number
061 No action taken – unable to back out prior transaction – VISA only
062 Invalid Account type
063 Daily or monthly limit amount exceeded
064 Bad Track II
065 No DDA Account
066 No Savings Account
067 Invalid Transaction Date
068 Invalid Amount – STAR only
069 Account Closed – STAR only
070 Invalid PAN
071 Invalid response
072 Card on National Negative File
073 Format error – STAR only
075 Invalid PAN length
076 Insufficient Funds
078 Duplicate Transaction
081 Expired Card, Capture – STAR only
082 Suspected fraud, capture – STAR only
084 Restricted Card, capture – STAR only
086 Allowable pin tries exceeded [capture] – STAR only
087 Lost Card, capture – STAR only
088 Stolen card, capture – STAR only
089 Bad CVV2- field is missing – VISA only
092 Merchant Suspicious
095 Amount over Maximum
096 Blocked Country Code
097 Invalid Check Digit
098 Online Gambling prohibited
100 General denial – STAR only
113 Timeout
120 Force Post not applied – VISA only
122 Security Box down
123 Unable to perform validation
130 Unable to call Rule Engine
133 Daily or monthly limit count exceeded
134 Unable to locate previous message (no match on retrieval reference number) – VISA
only
135 Previous message located for a repeat or reversal, but repeat or reversal data
inconsistent with original – VISA only
136 Cryptographic error
137 Incorrect CVV/ICVV [Track 1 for STAR]
138 Unable to verify PIN
139 Invalid CVV – STAR only, track 2
143 Cash service not available (manual cash) – VISA only
150 Invalid Service Code
152 Unable to validate CVV2
153 Expiration Date Mismatch
154 Credit Account does not exist
206 Cardholder not found
208 Replacement amount greater than original amount – VISA only
209 Transaction not Allowed
210 Requested function not supported – STAR only
903 Pickup card – Stolen
997 Issuer is unavailable – Network stand-in
998 Processing Error in Rule Engine
999 Default reject