Skip to main content
The Cards API lets you create and manage virtual cards for your customers. Use it to issue cards, fund balances, set PINs for NGN Verve cards, freeze or unfreeze cards, regularize or terminate cards, retrieve transactions, and withdraw funds.

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. Parameters
string
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 issuer. Use VISA or MASTERCARD for USD cards and VERVE for NGN cards.
string
required
card type e.g DEFAULT, LITE or COOPERATE
number
Amount to pre-fund the card, expressed in the currencyโ€™s major unit.
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
NGN cards use currency: "NGN", issuer: "VERVE", and type: "DEFAULT". Set the four-digit PIN after issuance using the Set Card PIN endpoint.
NGN Verve card pricing currently includes an NGN 1,000 issuance fee and an NGN 500 declined transaction fee. Funding, withdrawal, and termination fees are zero until further notice. Request Body Provide necessary details to set up a new card.

๐Ÿ’ณโž• 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. Parameters
string
required
The unique identifier of the card to fund.
Body
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. Parameters
string
required
The unique identifier of the card to retrieve.

๐Ÿงพ Get Card Transactions

List transactions for a card with the card transactions endpoint. Use the card ID to review transaction amounts, statuses, fees, and merchant details.
string
required
The unique identifier of the card whose transactions you want to retrieve.

๐Ÿ› ๏ธ Regularize a Card

Use the regularize card endpoint when Swervpay instructs you to regularize a card. The endpoint accepts the card ID in the path and returns the operation result.
string
required
The unique identifier of the card to regularize.

โ„๏ธ Freeze a Card

Temporarily disable a card to prevent new transactions by using the freeze card endpoint. Path Parameters
string
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 Parameters
string
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 Parameters
string
required
The unique identifier of the card to withdraw from.
Body
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 Parameters
integer
The page to return.
integer
The maximum number of results to return.
Response Example The response returns an array of card objects with their respective details.