VA Transfer

Initiate bulk VA transfer

Changed on

Sends a single payout to one beneficiary, split across multiple provider payouts when the amount exceeds the provider limit. This is not a way to pay many different recipients in one request. The fee is calculated once on the full amount and the total debit is reserved once.

post/v1/va/transfer/bulk

Request

Headers

idempotency-keystring required

Request body

beneficiaryobject
beneficiaryIdstring
currency'NGN' | 'KES' | 'ZAR' | 'GHS' | 'XOF' | 'USD' required
amountnumber required
narrationstring required
splitCountnumber

Optional number of provider payouts to split this transfer into. If omitted, Kyshi auto-splits by provider payout limit.

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",
  "splitCount": 20
}

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

    • 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

    • breaking

      the header request parameter idempotency-key became required

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the /// response's property format changed from uuid to no format for status

    • breaking

      the // response's property type changed from integer to number for status

    • breaking

      the // response's property format changed from uuid to no format for status

    • breaking

      the //// response's property format changed from uuid to no format for status

    • breaking

      the //// response's property type changed from integer to number for status

    • breaking

      the //// response's property format changed from uuid to no format for status

    • breaking

      the //// response's property format changed from uuid to no format for status

    • breaking

      the // response's property type changed from integer to number for status

    • breaking

      the // response's property type changed from integer to number for status

    • breaking

      the // response's property type changed from integer to number for status

    • warning

      removed subschema #2 from the request body allOf list

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new ASSET_MFB enum value to the // response property for the response status

    • warning

      added the new ASSET_MFB enum value to the // response property for the response status

    • warning

      added the new CHOICE enum value to the // response property for the response status

    • warning

      added the new COLLECTED enum value to the //// response property for the response status

    • warning

      added the new FAILED enum value to the //// response property for the response status

    • warning

      added the new FLUTTERWAVE enum value to the // response property for the response status

    • warning

      added the new IN_REVIEW enum value to the //// response property for the response status

    • warning

      added the new MANUAL_OTC enum value to the // response property for the response status

    • warning

      added the new MOMENTPAY enum value to the // response property for the response status

    • warning

      added the new PAGA enum value to the // response property for the response status

    • warning

      added the new PAWAPAY enum value to the // response property for the response status

    • warning

      added the new PAWAPAY enum value to the // response property for the response status

    • warning

      added the new PAYSTACK enum value to the // response property for the response status

    • warning

      added the new PAYSTACK enum value to the // response property for the response status

    • warning

      added the new PENDING enum value to the //// response property for the response status

    • warning

      added the new PROVIDUS_BANK enum value to the // response property for the response status

    • warning

      added the new REVERSAL enum value to the //// response property for the response status

    • warning

      added the new STERLING enum value to the // response property for the response status

    • warning

      added the new STITCH enum value to the // response property for the response status

    • warning

      added the new STRIPE enum value to the // response property for the response status

    • warning

      added the new STRIPE enum value to the // response property for the response status

    • warning

      added the new SUCCESS enum value to the //// response property for the response status

    • warning

      added the new VFD enum value to the // response property for the response status

    • warning

      added the new VFD_VA enum value to the // response property for the response status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added 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

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      removed the NGN enum value from the // response property for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status