Initiate Transfer
Send money to your customers.
Transfer will be pending if OTP is yet to be provided.
Request Details
Field | Data type | Required | Description |
---|---|---|---|
beneficiary.accountNumber | string | Yes | The recipient's number according to their account registration. |
beneficiary.accountName | string | Yes | The recipient's name according to their account registration. |
beneficiary.bankName | string | Yes | Required for all recipient types. You can get the list of Bank Names by calling the List Banks endpoint . |
beneficiary.bankCode | string | Yes | Required for all recipient types. You can get the list of Bank Codes by calling the List Banks endpoint. |
currency | string | Yes | See Supported Currencies only NGN available for now |
amount | number | Yes | Amount to transfer |
narration | string | Yes | The reason for the transfer |
After collecting the necessary details. Make a POST request to our transfer endpoint.
Note : Before making a post request, the secret key should be specified in the header.
-H "x-api-key: your_secret_key".
{{host}}/v1/transfer
If the API call is successful, Kyshi returns the following response:
{
"beneficiary": {
"accountNumber": "1111111103",
"accountName": "FEMI ZACK",
"bankCode": "000002",
"bankName": "Keystone Bank"
},
"amount": 1000,
"narration": "TEST",
"currency": "NGN"
}
{
"status": true,
"code": 201,
"message": "Success",
"data": {
"transferCode": "999999"
}
}
Updated 2 months ago