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

Transaction Processing Codes

Message Type Processing Code Description
15B/15BR 070000 Cash out – function 034
15I/15IR 320000 Card Transfer Out – Debit – function 035
27I/27IR 320000 Card Transfer In – Credit – function 035
15J/15JR 230000 Withdrawal from Card– function 007*
27J/27JR 230000 Deposit to Card – function 007*
15L/15LR 340000 Cardholder Fee – Debit – function 030*
27L/27LR 340000 Cardholder Fee – Credit – function 030*
15M/15MR 330000 Debit Adjustment – reduce card bal – function 031
27M/27MR 330000 Credit Adjustment – increase card balance –
function 031
15M/15MR 390000 Base II adjustment transaction – debit – function 031
27M/27MR 390000 Base II adjustment transaction – credit – function 031
27X/27XR 370000 Deposit to Card from Instant Issue – function
15N/15NR 380000 Monthly Cardholder Fee – function 030
0100/0110 000000 Authorization Purchase from Funding
0100/0110 002000 Authorization Purchase from DDA
0100/0110 010000 Cash Disbursement from Funding
0100/0110 012000 Cash Disbursement from DDA
0100/0110 110000 Quasi Cash purchase from Funding
0100/0110 112000 Quasi Cash purchase from DDA
0100/0110 180000 POS with Cash -back
0100/0110 300000 Balance Inquiry
0100/0110 302000 Balance Inquiry from DDA
0101/0110 000000 Authorization Purchase repeat from Funding
0101/0110 002000 Authorization Purchase repeat from DDA
0101/0110 010000 Cash Disbursement repeat from funding
0101/0110 012000 Cash Disbursement repeat from DDA
0400/0410 000000 Authorization Purchase reversal from funding
0400/0410 002000 Authorization Purchase reversal from DDA
0400/0410 010000 Cash Disbursement reversal from funding
0400/0410 012000 Cash Disbursement reversal from DDA
0400/0410 110000 Quasi Cash reversal from Funding
0400/0410 112000 Quasi Cash reversal from DDA
0401/0410 000000 Authorization purchase reversal repeat from funding
0401/0410 002000 Authorization purchase reversal repeat from DDA
0401/0410 010000 Cash Disbursement reversal repeat from funding
0401/0410 012000 Cash Disbursement reversal repeat from DDA
0401/0410 110000 Quasi Cash reversal repeat from funding
0401/0410 112000 Quasi Cash reversal repeat from DDA