Initiate VA Transfer

Initiate a VA transfer from your available NGN virtual account transfer balance.

You can initiate a transfer with an existing beneficiaryId, or provide a beneficiary object and Kyshi will find or create the beneficiary during initiation.

-H "x-api-key: your_secret_key"
POST {{host}}/v1/va/transfer

Request Body

FieldData TypeRequiredDescription
beneficiaryIdstringYes, if beneficiary is not suppliedExisting VA beneficiary ID.
beneficiaryobjectYes, if beneficiaryId is not suppliedBeneficiary details. Use the same fields as Create VA Beneficiary.
currencystringYesUse NGN.
amountnumberYesAmount to transfer in NGN.
narrationstringYesTransfer narration.
{
  "beneficiaryId": "8495ec4e-ce21-405f-b0cf-982702881f4d",
  "currency": "NGN",
  "amount": 2000,
  "narration": "Supplier payout"
}

If the API call is successful, Kyshi returns the transfer code, transaction reference, and applicable fees.

{
  "status": true,
  "message": "Success",
  "code": 201,
  "data": {
    "transferCode": "TRF_HzmYr2nf1TIdilc",
    "reference": "KYSHI-1778623597453",
    "fees": {
      "vat": 0,
      "fee": 5,
      "processorFee": 10,
      "allInclusiveKyshiFee": 5,
      "others": {},
      "totalFees": 15,
      "vfdPercent": 0,
      "vfdCap": 0,
      "vfdFlat": 10,
      "vfdStampDuty": 0,
      "vfdStampDutyThreshold": 0,
      "stampDuty": 0
    }
  }
}

Notes

  • The total amount debited is the transfer amount plus totalFees.
  • Kyshi returns Insufficient Funds if your available balance cannot cover the transfer amount and fees.