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


Create Wallet for Existing Cardholder – Function CreateCardholderWallet

Creates a financial Wallet for an existing Cardholder. The Card/Account supplied to this function will become the default purse for this multi-currency Card within the Wallet. The existing Card’s Program/Binclient currency will become the currency type of this default purse. Additional purse accounts denominated in other currencies may be created and associated with this Card in the Wallet via the Wallet API function CreateCardPurse.

The Cardholder identification is passed to this function as either the PAN or the Cardholder ID alternate identifier (ALTID FLAG = H). This Card must have previously been assigned to the Cardholder via either the CardAPI function Instant Card Issue or Assign Card to Cardholder.

Optionally the caller may specify the Wallet ID to be assigned. If omitted the existing Cardholder ID will be used as the Wallet ID. The wallet creation requires that the cardholder have a Date of Birth on record. The API username must be 12 or fewer characters.

Inputs Description Required Data Type
FunctionID CreateCardholderWallet Y
P1 PAN OR ALT ID ’H’ Y (12…24) Alphanumeric
P2 Wallet ID to assign N (12…24) Alphanumeric
Output Description
P1 Error Code Y
P2 Error Text Y
P3 Wallet ID Assigned Y
Notice the port number for Wallet API calls is 9000 instead of 8443 for Card API calls.

P1=000&P2=Wallet Create Successful&P3=301420041023