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


Currency Amounts and Conversion Instructions

1. Currency amounts are transmitted as integers with the resolution of the smallest available unit (e.g., cents) per currency, e.g., $10.50 is represented as 1050. If an amount is transmitted with a decimal the transaction will be rejected.

2. An ISO 4217 currency code must be specified as a separate parameter any time a currency amount is transmitted.

3. Error code 021 is returned if a currency is attempted against a BIN for which that BIN was not assigned that currency.

4. If a currency code is specified that is different from the Settlement Currency Code, a conversion is done. The API will find the real-time currency exchange rate and use that exchange rate to convert the amount from the Currency Code to the Settlement Currency Code.

5. There are two system parameters that affect Currency Conversion:

a. The first parameter configures the preference of whether to use the real-time bid, ask, or rate quote as the conversion multiplier. You must specify this configuration parameter on setup with your representative.
b. The second parameter configures the Settlement Currency Code override. If this parameter is configured, any Settlement Currency Code sent by the API will not be used in deference to the override parameter. Therefore, the Currency Code will be converted to the system parameter Settlement Currency Code and not the Settlement Currency Code in the incoming message.