Overview
Swerv Card API allows businesses to create card for their customer to pay anywhere global
This API provides a powerful, secure, and easy-to-use set of endpoints for card management, including creation, retrieval, freezing, and termination of cards. This guide will cover essential operations to help you manage card transactions within your applications
📇 Create a Card
Initiate the creation of a virtual or physical card by sending a request to the create card endpoint.
Parameters
The unique identifier for the customer to whom the card will be issued.
The three-letter ISO currency code in uppercase.
The cardholder name that may appear on the card.
card provider e.g MASTERCARD, VISA
card type e.g DEFAULT, LITE
amount to pre-fund the card
Note: customer_id is required for DEFAULT card type
Request Body
Provide necessary details to set up a new card.
{
"customer_id": "user",
"currency": "USD",
"provider": "MASTERCARD",
"name_on_card": "Swerv",
"amount": 10,
"type": "DEFAULT"
}
💳➕ 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
The unique identifier of the card to fund.
Body
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
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 Parameters
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
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
The unique identifier of the card to withdraw from.
Body
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
The page to return.
The maximum number of results to return.
Response Example
The response returns an array of card objects with their respective details.
[
{
"id": "card_123456789",
"type": "virtual",
"status": "active",
"card_number": "4242424242424242",
"expiry": "12/34",
"cvv": "123",
"name_on_card": "John Doe",
"balance": 500000, // Balance in the smallest currency unit
"total_funded": 1500000, // Total funded in the smallest currency unit
"freeze": false,
"address_street": "123 Swyft Street",
"address_city": "Paytown",
"address_state": "Paystate",
"address_country": "NG",
"address_postal_code": "123456",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-02T00:00:00Z",
"masked_pan": "424242******4242"
}
// ...other cards
]