Overview
Swerv Collection allows businesses to accept payments from their customers using virtual accounts & payment link.
Supported partners
Below are the list of currently supported partners for virtual account issuing
- VFD Microfinance Bank
- Providus Bank (🚧 Coming soon)
- Guaranty Trust Bank (🚧 Coming soon)
- Globus (🚧 Coming soon)
Create Virtual Account
To create a virtual account, use the create collection endpoint.
Parameters
The unique identifier for the customer to whom the card will be issued.
The three-letter ISO currency code in uppercase.
merchant name that will be displayed on the virtual account. Required for ONE_TIME (Temporary) virtual account.
virtual account type e.g DEFAULT (Permanent), ONE_TIME (Temporary)
amount expected to be paid into the virtual account. Required for ONE_TIME (Temporary) virtual account.
Note: customer_id is required for (DEFAULT) permanent virtual account
{
"customer_id": "user",
"currency": "NGN",
"merchant_name": "Swerv",
"amount": 10,
"type": "ONE_TIME"
}
🔍 Get Collection Details
Retrieve detailed information of a specific collection with their unique identifier using the get collection endpoint.
Path Parameters
The unique identifier of the collection to retrieve.
🔍 Get All collections
Retrieve a list of all collections by sending a request to the get all collections endpoint.
Query Parameters
The page to return.
The maximum number of results to return.
Response Example
The response provides an array of wallet objects, each containing comprehensive details about the wallets associated with your Swerv account.
[
{
"account_name": "string",
"account_number": "string",
"account_type": "string",
"balance": 100000, // Balance in the smallest currency unit
"bank_address": "string",
"bank_code": "string",
"bank_name": "string",
"created_at": "2024-01-01T00:00:00Z",
"id": "wlt_123456789",
"is_blocked": false,
"pending_balance": 50000, // Pending balance in the smallest currency unit
"reference": "string",
"routing_number": "string",
"total_received": 1500000, // Total amount received in the smallest currency unit
"updated_at": "2024-01-02T00:00:00Z"
}
// ...other wallets
]