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


CARDHOLDER API’S

The following is a breakdown of required Client APIs. The parameters defined in the Message Format section will be required for each function defined below. These parameters are utilized for validation to access the system. In addition, the MSGID will need to be a unique counter for each transaction. AuthENGIN API returns responses in two formats. The first format uses name value Pairs that are separated by an Ampersand (&).

E.g.: P1=000&P2=Assign Card-to-Card Holder successful.

AE CardAPI also uses XML to respond to certain requests. Some of the calls like transaction history can return multiple rows of data therefore they can be better displayed using XML. E.g.:

<?xml version=”1.0” ?>
<api func=”035”>
<p1 errnumber=”0000” errdescription=”” />
<TransferInfo>
<CardNumber>################</CardNumber>
<TransferAmount>200</TransferAmount>
<TransferBaseCurrency>840</TransferBaseCurrency>
<TransferFee>100</TransferFee>
<TransferToCardNumber>################</TransferToCardNumber>
</TransferInfo>
</api>

An API response contains error code when the transaction is not successful. There is a list of error codes, which are returned part of an erroneous response at the end of the document.