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


Adjustment – Function 031

Function 031 helps adjust the card balance up or down. This API call has three main parameters. The second parameter (P2) accepts both positive and negative amounts. A negative adjustment requires a (-) sign in front of the amount field. There is also a provision for the fee amount. Remember the fee always deduct the applied fee amount from the balance.

Inputs Description Required Data Type
FunctionID 031 Y
P1 PAN OR ALT ID Y (16,19) numeric
P2 Adjustment Amount (insert a negative sign (-) for
adjusting balances down (e.g.: P2= – 200)). For
adjusting amounts up simply put the adjustment
amount. (E.g.: P2=300)
Y numeric
P3 Fee amount. This field will always deduct
the applied amount from card balance
Y numeric
P4 Description for the transaction Y (0, 30) varchar
P5 Currency Code (ISO4217-Alpha) N (3) varchar
P6 Settlement Currency Code (ISO4217-Alpha) N (3) varchar
Outputs Description
P1 Error Code Y
P2 Error Text Y
Adjustment Amount N
fee Fee Amount N
Symbol Conversion symbol N e.g.)AUDUSD
Rate Exchange Rate used for transaction N
Example: Adjustment Request or ALT ID&P2=200&P3=100&P4=ServiceFee
Example: Adjustment Response
P1=0000&P2=Adjustment Successful
Example: Adjustment Request
tome &FUNC=031&MSGID=00005098895747687&P1=PAN or ALT
Example: Adjustment Response