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

PROCESSING CODES

Processing Code Description Function
TBD Change Account Status TBD
TBD Change Account Access TBD
020000 Set PIN 022
050000 Change Card PIN 005
050000 PIN Reset 037
060000 Change Card Status 004
070000 Cash Out 034
080000 Card Link 032
220000 Assign Card to Cardholder 011
230000 Withdrawal from Card 007
230000 Deposit to Card 007
260000 Update Cardholder 036
270000 Instant Card Issue 002
320000 Card Transfer Out – Debit 035
320000 Card Transfer In – Credit 035
330000 Debit Adjustment – reduce card bal 031
330000 Credit Adjustment – increase card balance 031
340000 Cardholder Fee – Debit 030
340000 Cardholder Fee – Credit 030
380000 Monthly Cardholder Fee 030
350000 Unblock Bad PIN Tries 040
370000 Deposit to Card from Instant Issue
390000 Base II Settlement Transaction 031
001 Create Card Holder 001
003 Automated Load 003
023 Get Card Status 023
009 View Statement Summary (Cardholder Summary) 009
010 View Statement Details (Transaction History) 010
024 Get Cardholder Account Balance 024
012 Validate PIN for Card 012
033 Card Inquiry 033
008 Message Look Up 008
025 Heartbeat 025
056 OFAC Check 056
057 Request Direct Deposit Number 057
CreateMerchant Create Merchant
MultiCurrency Get real-time currency exchange rates