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


Alternatives to Using Card Number in the CardAPI

Beginning with AE CardAPI version 4.15 API users may use several other customer identifiers in place of card number. A flag value must be placed in front of the identifier to indicate the location or type of information used.

A Account ID
B Partial Last Name + Account ID
C Partial Card Number
N Cardholder ID
I Cardholder ID – internal format
S Person ID (SSN)

All API users may use alternate ids in place of card number. In some cases, users may be restricted to use only alternate ids. The alternate ids that may be used must be defined within the user configuration table as illustrated below.


This indicates that the user may submit account id or personal id in place of a card number.
Additionally, with ALTID set this user cannot submit a card number or any other identifier.

The API has been modified so that the alternate id will be returned in place of card number in those responses where card number is part of the normal response.

When a user attempts to use any ID other than one allowed the user will receive the following message.

P1=090&P2=Inadequate permissions to execute this alternate ID

It is important for users who use the alternate IDs to create ID numbers that are relatively unique. For example, when using DDA Account IDs the number should include elements like ABA number with account number. This is because many of the values that may be used are not currently validated to be unique within the system. In the event the system detects a number that is not unique the system will return

P1=5100&P1=AltID Anyaccountid not unique. Note that other data combination may be possible.