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


PIN Encryption

In each message involving transmission of a PIN, the PIN value is encrypted using Triple DES algorithm in ECB mode with a shared encryption key agreed upon outside the API. The cipher text is encoded with Base64 (RFC1341) and passed as the PIN parameter.

3DES ECB algorithm operates on 8-byte blocks. The transmitted value will always be 12 characters long because of Base64 encoding of 8-byte cipher text. Use of 3DES makes a data unreadable without knowing the key. 3DES is derived from the well know DES algorithm except that in 3DES the data block is Encrypted, decrypted. and encrypted 3 times and hence the name 3DES.

Clients can encrypt the PINS with the key that they choose. Once the PIN is encrypted, clients need to transmit the key to Digital Payments in the Base64 encoded format. Make sure that your data is URL encoded) before it is transmitted. This is absolutely imperative, since “+”, “/”, “= are special character and have a special meaning in the URL. For safe transmission of these characters, the URL data needs be encoded before it is transmitted.