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


Deposit to Card Number – Function 007

Function 007 API call will add or remove funds to a card. This call is also referred to as “Add Funds” or “Load funds” and similarly “Remove funds” or “Unload funds”. Remember to set the P5 flag correctly when adding or removing funds to the card. If fees are provided, this function will call AuthENGINAPI FUNC=030 Cardholder Fees. When Cardholder Fees is called, any fees that need currency conversion will have been converted to the Settlement currency.

Inputs Description Required Data Type
FunctionID 007 Y
P1 PAN OR ALT ID Y (16,19) numeric
P2 Amount Y numeric
P3 Reserved N
P4 Transaction Type (0 = Credit, 1 = Debit) Y 0 or 1
P5 Currency Code (ISO 4217 – Alpha) N* (3) varchar
P6 Settlement Amount N numeric
P7 Settlement Currency Code (ISO 4217 – Alpha) N* (3) varchar
P8 Transaction Description Y (0,30) varchar
P9 Terminal Owner N (1,30) varchar
P10 Terminal Location N (1,30) varchar
P11 Terminal City N (1,13) varchar
P12 Terminal State N (2) varchar
P13 Terminal ID N (20) numeric Right justified zero padded
P14 Country N (2) varchar
P15 Transaction Flat Fee (debit only) N numeric
P16 Fee Description N (1,30) varchar
direct Fee Populate this fee and AE will apply it as an adjustment. Do not use currency conversion with this fee. – one-time fee applicable to this transaction N (0,6) Numeric
Outputs Description
P1 Error Code Y
P2 Error Text Y
Symbol Currency Conversion symbol N e.g.)AUDUSD
Rate Exchange Rate used for transaction N
amount Converted Rate of deposit N
Example: Card Deposit/Remove Request
e&FUNC=007&MSGID=00001594011000282&P1= PAN OR ALT
Examples: Card Deposit/Remove Response

* The initial API user configuration normally designates a ‘Base Currency’ and there are several scenarios that can occur if these fields are populated with the currency of the transaction and settlement:

  1. If the base currency is defined and the transaction is the same currency, these fields are not required.
  2. If the base currency is not defined and the fields are not populated, USD is assumed. If other than USD, then the fields become required.
  3. If the base currency is defined and the transaction is the same currency as the base currency, but the fields are defined, currency conversion will occur assuming base currency is USD currency.

*Difference between P15 – Flat Fee and Direct Fee