Initiate bulk VA transfer
Changed onSends 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.
Request
- Base URLhttps://api.kyshi.co
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Request body
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.
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
headerrequest parameteridempotency-keybecame required - breaking
the
response's property type changed fromobjectto no type for status - breaking
the
///response's property format changed fromuuidto no format for status - breaking
the
//response's property type changed fromintegertonumberfor status - breaking
the
//response's property format changed fromuuidto no format for status - breaking
the
////response's property format changed fromuuidto no format for status - breaking
the
////response's property type changed fromintegertonumberfor status - breaking
the
////response's property format changed fromuuidto no format for status - breaking
the
////response's property format changed fromuuidto no format for status - breaking
the
//response's property type changed fromintegertonumberfor status - breaking
the
//response's property type changed fromintegertonumberfor status - breaking
the
//response's property type changed fromintegertonumberfor status - warning
removed
subschema #2from the request bodyallOflist - warning
removed the optional property
///from the response with the status - warning
added the new
ASSET_MFBenum value to the//response property for the response status - warning
added the new
ASSET_MFBenum value to the//response property for the response status - warning
added the new
CHOICEenum value to the//response property for the response status - warning
added the new
COLLECTEDenum value to the////response property for the response status - warning
added the new
FAILEDenum value to the////response property for the response status - warning
added the new
FLUTTERWAVEenum value to the//response property for the response status - warning
added the new
IN_REVIEWenum value to the////response property for the response status - warning
added the new
MANUAL_OTCenum value to the//response property for the response status - warning
added the new
MOMENTPAYenum value to the//response property for the response status - warning
added the new
PAGAenum value to the//response property for the response status - warning
added the new
PAWAPAYenum value to the//response property for the response status - warning
added the new
PAWAPAYenum value to the//response property for the response status - warning
added the new
PAYSTACKenum value to the//response property for the response status - warning
added the new
PAYSTACKenum value to the//response property for the response status - warning
added the new
PENDINGenum value to the////response property for the response status - warning
added the new
PROVIDUS_BANKenum value to the//response property for the response status - warning
added the new
REVERSALenum value to the////response property for the response status - warning
added the new
STERLINGenum value to the//response property for the response status - warning
added the new
STITCHenum value to the//response property for the response status - warning
added the new
STRIPEenum value to the//response property for the response status - warning
added the new
STRIPEenum value to the//response property for the response status - warning
added the new
SUCCESSenum value to the////response property for the response status - warning
added the new
VFDenum value to the//response property for the response status - warning
added the new
VFD_VAenum value to the//response property for the response status - info
the endpoint scheme security
ApiKeyAuthwas 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
allOflist for the response status - info
removed from the response body
allOflist 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
NGNenum 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
- breaking