Card Details Encryption
All card details are encrypted follows the AES standard with the following parameters:- Algorithm: AES (RijndaelManaged)
- Mode: CBC (Cipher Block Chaining)
- Padding: PKCS7
- Block Size: 128-bit
- Key & IV: Derived from your registered Business ID:
- Key: The first 16 characters of your Business ID
- IV (Initialization Vector): The last 16 characters of your Business ID
Encrypted Card Details Payload
π Create a Card
Initiate the creation of a virtual or physical card by sending a request to the create card endpoint. Parametersstring
The unique identifier for the customer to whom the card will be issued.
string
required
The three-letter ISO currency code in uppercase.
string
The cardholder name that may appear on the card.
string
required
card provider e.g MASTERCARD, VISA
string
required
card type e.g DEFAULT, LITE or COOPERATE
integer
amount to pre-fund the card
string
The expiry date of the card in the format YYYY-MM-DD.
string
Phone number of the cardholder (for cooperate & lite card type only)
string
RC Number of the company (for cooperate card type only)
string
BVN of the director of the company (for cooperate card type only)
string
Business email of the company (for cooperate card type only)
string
Document number of the company (for lite card type only)
string
Document type of the company (for lite card type only)
Note:
customer_id is required for DEFAULT card typeπ³β Fund Card
Add funds to an existing card using the fund endpoint. This operation is essential for increasing the cardβs available balance for use. Parametersstring
required
The unique identifier of the card to fund.
integer
The amount to fund in the smallest currency unit.
π Get a Card
Retrieve information about a specific card with its unique identifier using the get card endpoint. Parametersstring
required
The unique identifier of the card to retrieve.
βοΈ Freeze a Card
Temporarily disable a card to prevent new transactions by using the freeze card endpoint. Path Parametersstring
required
The unique identifier of the card to freeze/unfreeze.
π« Terminate a Card
Permanently disable a card and remove it from your account with the terminate card endpoint. Path Parametersstring
required
The unique identifier of the card to terminate.
πΈ Withdraw from Card
Withdraw funds from the card back to your business account using the withdraw-from-card endpoint. Path Parametersstring
required
The unique identifier of the card to withdraw from.
integer
The amount to fund in the smallest currency unit.
ποΈ Get All Cards
To retrieve a comprehensive list of all the cards, use the get all cards endpoint. This method provides a paginated list of cards, complete with details for each card, allowing for effective oversight and management. Query Parametersstring
default:1
required
The page to return.
string
default:10
required
The maximum number of results to return.