KYkyshi
Transfers

Create beneficiary

Changed on

Saves a payout beneficiary and returns its ID. Reuse the ID for anyone you pay more than once, rather than re-entering account details.

post/v1/transfer/beneficiaries

Request

Request body

accountNamestring required
accountNumberstring required
bankNamestring required
bankCodestring required
currency'NGN' | 'KES' | 'ZAR' | 'GHS' | 'XOF' | 'USD' required
descriptionstring required
bvnstring required
nameEnqRefstring

Example request

{
  "accountName": "John Clam",
  "accountNumber": "2250734567890",
  "bankName": "Orange CIV",
  "bankCode": "ORANGE_CIV",
  "currency": "XOF",
  "description": "Monthly payout beneficiary",
  "bvn": "22222222222",
  "nameEnqRef": "name-enquiry-ref-100045"
}

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

  • 4aed77604588Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added the new USD enum value to the request property

    • info

      added the new XOF enum value to the request property

    • info

      added the new ZAR enum value to the request property

    • info

      added subschema #2 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