Transfers

Initiate transfer

Changed on Nov 3, 2026

Sends a payout to a saved or inline beneficiary. Your available balance must cover both the amount and the payout fees. A successful response means accepted, not delivered.

post/v1/transfer

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

Request body

beneficiaryobject

beneficiaryIdstring

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

amountnumber required

narrationstring required

Example request

{
  "beneficiary": {
    "accountName": "John Clam",
    "accountNumber": "2250734567890",
    "bankCode": "ORANGE_CIV",
    "bankName": "Orange CIV",
    "currency": "XOF"
  },
  "beneficiaryId": "b6f6a56f-1e55-4fb0-a9d4-8fdd680fd0a1",
  "currency": "XOF",
  "amount": 1500,
  "narration": "Customer withdrawal"
}

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
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- 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
  added the new USD enum value to the request property
- info
  added the new XOF enum value to the request property
- info
  added the new ZAR enum value to the request property
- info
  the request property format was generalized from uuid to no format
- 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