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


Multi-currency Card Purse to Purse Transfer – Function PurseFundsTransfer

Converts and transfers funds between purses within an existing multi-currency Card. The multi- currency Card must have previously been assigned to a Wallet using the CardAPI function CreateCardholderWallet, and purses other than the default created and assigned using the CreateCardPurse function.

The Purse identifications are passed to this function as either the card account’s PAN or the Cardholder ID alternate identifier (ALTID FLAG = H).

The amount specified will be in the currency of the FROM Purse. That amount will be deducted from the FROM Purse. The amount after currency conversion will be moved into the TO Purse.

Inputs Description Required Data Type
FunctionID PurseFundsTransfer Y
P1 PAN OR ALT ID ’H’ for FROM purse Y (12…24) Alphanumeric
P2 Amouont Y Numeric
P3 PAN OR ALT ID ’H’ for TO purse Y (12…24) Alphanumeric
Output Description
XML The data will be passed back in a well-formed XML document. The error code processing will be contained in the P1 node that contains two attributes: errnumber and errdescription. Therefore, if the errnumber attribute is equal to “000” the document will contain a “transferinfo” node; otherwise, it will not. Y
Example: PurseFundsTransfer Request
Example: PurseFundsTransfer Response
<?xml version=”1.0”?>
<api func=”PurseFundsTransfer”>
<p1 errnumber=”000″ errdescription=”” />