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


API Message Format

The API Request must be submitted using a name/value pair format.

a) The Name of the field submitted is always first.

b) Value of the field submitted is always second.

c) The Format is the Name followed with an equal sign followed by the Value followed by an ampersand. There must be NO SPACES in front of or following either the equal sign or the ampersand. Only the parameters necessary for each function should be passed. At the very end of the Request, leave off theampersand.

d) The order or sequence of the Name/Value Pairs submitted is not important. The user must ensure however that all name/value pairs that are required to be submitted are included.


Message format example:
Required fields for all Requests:

Inputs Description Required Data Type
CID Client ID Y (1,4) numeric
CUSR Client User ID Y (5,12) varchar
CPWD Client Password Y (8,20) varchar
FUNC Function ID Y numeric
MSGID Message ID Y numeric
1-5 characters reserved for Client ID left padded with zeros.
6-17 characters reserved for message id counter.
Outputs Description

A brief overview of the Request processing follows:

1. The AE CardAPI receives the request.

2. The program will then process the request. Processing includes:

a. Validation of the user information (user account information)
b. Validation of the transaction information – Validates to ensure all required fields are present, allowable based on the User Account, and contains correctly formatted content, and data type. If required fields are not present, an error message is returned, and the Request is declined.

3. When all the information has been processed, the AE CardAPI adds any additional information, as necessary, to the response, and reformats it into the correct format to send back to the user.

4. The AE CardAPI sends the response back to the user.