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


3DS Enrolment Control – Function THREEDS

Function THREEDS is used to control the enrolment of a cardholder for 3DS enabled programs. This function allows for a card to be enrolled and unenrolled with our 3DS provider.


The language list (separated by commas) supports either the entire language name such as ENGLISH, FRENCH, SPANISH and GERMAN; or the first letter such as E, F, S and G.

Inputs Description Required Data Type
P1 PAN or ALT ID Y (16,19) numeric
P2 Action. E to Enroll a card. U to Unenroll a card. Y (1) alpha – E or U
P3 3DS Language Preferences. Supported languages are English, Spanish, French and German. Y Comma Separated List of Languages
Outputs Description
P1 Error Code Y
P2 Error Text Y
Example: 3DS Enroll/Unenroll Card Request
dassignedtome&FUNC=THREEDS&MSGID=00001704406600030&P1=PAN or ALT
dassignedtome&FUNC=THREEDS&MSGID=00001704406600030&P1=PAN or ALT ID&P2=U&P3=E,F
Example: 3DS Enrollment Tries Response
P1=0000&P2=Card Enrolled
P1=0000&P2=Card Un-Enrolled
P1=0000&P2=Card Already Enrolled
P1=0000&P2=Card Not Enrolled