Kuda’s API Request Method

To make error-free requests using Kuda's Business API, it's important to know the structure of its API requests, which consist of three object categories:

  1. Service Type - When calling Business API, the serviceType parameter helps specify the type of operation you want to perform. See list of service types for more information.
  1. Request Reference - Help you keep track of your request; you can create a unique reference number for each request you make.
  1. Data - The main request parameters are contained within the data object. Any necessary data for the request can be passed into this object.
NameObjectsType
Service TypeserviceTypestring
Request ReferencerequestRefstring
Datadataobject
Sample Request

JSON

Copy

{
    "serviceType": "service_type_name", // Name of operation
    "requestRef": "reference_value", // Your custom unique reference number
    "data": { // Main request body
        "param1": "value_here",
        "param2": "value_here"
    },
}

Sample Request Structure

Here's an example of how to send an API request:

Sample Request

CURL

Copy

curl \
-H 'Content-Type: application/JSON' \
-H "Authorization: Bearer {access_token}"
-d '{
      serviceType": "NAME_ENQUIRY",
      "requestRef": "611sad12dfw2qd2",
      "Data": {
        "BeneficiaryAccountNumber": "7000016172",
        "BeneficiaryBankCode": "999129"
      }
}' \
-X POST https://kuda-openapi.kuda.com/v2.1
Note

Please ensure that all service types in Upper Case, and be sure to check for any spelling errors in your request body as data object keys are not case sensitive.

Was this page helpful?