VA Transfer

Create VA beneficiary

Changed on Nov 3, 2026

Saves a beneficiary for the virtual-account rail. VA beneficiaries are separate from standard transfer beneficiaries; an ID from one rail is not valid on the other.

post/v1/va/transfer/beneficiaries

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/va/transfer/beneficiaries/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

accountNamestring required

accountNumberstring required

bankNamestring required

bankCodestring required

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

descriptionstring required

bvnstring required

nameEnqRefstring

Example request

{
  "accountName": "John Clam",
  "accountNumber": "2250734567890",
  "bankName": "Orange CIV",
  "bankCode": "ORANGE_CIV",
  "currency": "XOF",
  "description": "Monthly payout beneficiary",
  "bvn": "22222222222",
  "nameEnqRef": "name-enquiry-ref-100045"
}

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
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  the request's body type changed from no type to object
- warning
  removed subschema #2 from the request body allOf list
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  added the new optional request property
- 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