Virtual Accounts

Create virtual account

Changed on Nov 3, 2026

Creates bank account details for a customer to transfer into. When feeBearer is CUSTOMER, show the returned payableAmount rather than requestedAmount: it includes fees and is rounded to a figure the customer can transfer.

post/v1/wallets

Request

Base URL
https://api.kyshi.co
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/wallets/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

customerobject required

currency'NGN' | 'KES' | 'ZAR' | 'GHS' | 'XOF' | 'USD' required

accountType'INDIVIDUAL' | 'COOPERATE' required

accountCategory'DEDICATED_VIRTUAL_ACCOUNT' | 'VIRTUAL_ACCOUNT' required

bank'PROVIDUS_BANK' | 'STERLING' | 'VFD' | 'CHOICE' | 'ASSET_MFB'

referencestring

expiresAtstring required

Expiry duration in minutes for temporary virtual accounts.

amountnumber required

feeBearer'MERCHANT' | 'CUSTOMER'

Example request

{
  "customer": {
    "firstName": "Dom",
    "lastName": "Aba",
    "email": "dom@yopmail.com",
    "phoneNumber": "2348012345678"
  },
  "currency": "NGN",
  "accountType": "INDIVIDUAL",
  "accountCategory": "VIRTUAL_ACCOUNT",
  "bank": "VFD",
  "reference": "VA-ORDER-100045",
  "expiresAt": "1440",
  "amount": 1000,
  "feeBearer": "CUSTOMER"
}

Response

Success.

statusboolean required

true on success.

messagestring required

codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

Nov 3, 20264aed77604588 Revision changes
- breaking
  the request property became required
- breaking
  the request property became required
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  the request property default value VIRTUAL_ACCOUNT was removed
- info
  the request property default value INDIVIDUAL was removed
- info
  added subschema #2 to the response body allOf list for the response status
- info
  removed from the response body allOf list for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history