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


Card Linking – Function 032

Function 032 requests help link two cards together to the same account. It takes the Card Number (Primary Account Number) associated with the primary account and the card number to be linked as the input parameters.

This transaction can also be used to reverse a link if there have been no transactions since the cards were initially linked. To reverse a link use the Primary Account Number (Card Number) as the P2 input and the card to be unlinked as the P1 input.

Inputs Description Required Data Type
FunctionID 032 Y
P1 Primary Account Number Y (16,19) Numeric
P2 Card To be Linked Y (16,19) Numeric
Outputs Description
P1 Error Code Y
P2 Error Text Y
Processing notes:
1. Linked cards must be within the same BIN/Sub-BIN P1=5809&P2=BIN #s don`t match
2. A card link cannot be reversed if a transaction has been processed after the link was completed. P1=5832&P2=Cannot reverse link
3. A primary account cannot be designated as a secondary account to another primary account. P1=5811&P2=Second card is a primary
4. A secondary account cannot be linked to another primary account until the original link is reversed. P1=5817&P2=Second card already linked
Example: Card Linking Request
C=0 32 &MSGID=00001089067000027&P1=4023540100000041&P2=4023540100000058
Example: Card Linking Response
P1=0000&P2=Card Linking Successful P1=0001&P2=Card Link Reversed
Error Codes
5811 – Second card is a primary 5813 – Primary card is secondary 5815 – Link already set 5817 – Second card already linked.
• The following errors indicate a possible issue with transaction history 5821 – SYNC BALANCES
(A1) 5822 – SYNC BALANCES (L1)
5830 – Card not a secondary 5832 – Cannot reverse link