Create Beneficiary
Creates a transfer beneficiary. duplicate account number will lead to the retrieval of the existing record.
Request Details
Field | Data type | Required | Description |
---|---|---|---|
accountName | string | Yes | The recipient's name according to their account registration. |
accountNumber | string | Yes | The recipient's number according to their account registration. |
bankName | string | Yes | Required for all recipient types. You can get the list of Bank Names by calling the List Banks endpoint . |
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 | Currency for the account receiving the transfer. See Supported Currencies only NGN available for now |
description | string | Yes | A description for this recipient |
After collecting the necessary details. Make a POST request to our transfers 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/beneficiaries
If the API call is successful, Kyshi returns the following response:
{
"accountName": "Raphael Ajilore",
"accountNumber": "1111111103",
"bankName": "Access Bank",
"bankCode": "000002",
"currency": "NGN",
"description": "TEST"
}
{
"data": {
"id": "8495ec4e-ce21-405f-b0cf-982702881f4d",
"accountName": "FEMI ZACK",
"accountNumber": "1111111103",
"bankName": "Keystone Bank",
"bankCode": "000002",
"bvn": "22222222224",
"description": "TEST",
"isActive": true,
"createdAt": "2024-07-08T14:25:58.115Z",
"updatedAt": "2024-07-08T14:25:58.115Z"
},
"status": true,
"message": "Success",
"code": 201
}
Updated 2 months ago