---
title: Initiate transfer
slug: initiate-transfer
docTags: 
createdAt: 2023-11-01T09:07:09.656Z
---

{
  "id": "wqhiaVpxz40PuWu5ZlssJ",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "/client/v1/transfer",
    "name": "Initiate transfer",
    "description": "<p>The document explains how to initiate a bank transfer. The response from the API call includes a message indicating that the bank transfer has been initiated, along with the reference of the transaction.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "kind": "required",
          "name": "X-CLIENT-ID",
          "type": "string",
          "description": "Your client ID"
        },
        {
          "kind": "required",
          "name": "X-SIGNATURE",
          "type": "string",
          "description": "The base64 encoded signature"
        },
        {
          "kind": "required",
          "name": "X-TIMESTAMP",
          "type": "string",
          "description": "The timestamp"
        },
        {
          "kind": "required",
          "name": "X-NONCE",
          "type": "string",
          "description": "The Nonce"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "transfer request",
          "customType": "clientApi.TransferRequest",
          "schema": [
            {
              "name": "reference",
              "kind": "required",
              "type": "string",
              "example": ""
            },
            {
              "name": "account_number",
              "kind": "required",
              "type": "string",
              "example": ""
            },
            {
              "name": "bank_code",
              "kind": "required",
              "type": "string",
              "example": ""
            },
            {
              "name": "amount",
              "kind": "required",
              "type": "number",
              "example": ""
            },
            {
              "name": "currency",
              "kind": "required",
              "type": "string",
              "example": ""
            },
            {
              "name": "narration",
              "kind": "optional",
              "type": "string",
              "example": ""
            }
          ],
          "modelRef": "#/definitions/clientApi.TransferRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "transfer initiated",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "transfer initiated",
            "customType": "clientApi.TransferRequestSuccessful",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "object",
                "example": "",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "string",
                    "example": ""
                  }
                ]
              },
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "example": "",
                "default": "transfer initiated"
              }
            ],
            "modelRef": "#/definitions/clientApi.TransferRequestSuccessful",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "whNxNNmIlt0-1IGGUuPxx",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url /client/v1/transfer \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --header 'x-client-id: string' \\\n     --header 'x-signature: string' \\\n     --header 'x-timestamp: string' \\\n     --header 'x-nonce: string' \\\n     --data '{\n     \"reference\": \"\",\n     \"account_number\": \"\",\n     \"bank_code\": \"\",\n     \"amount\": \"\",\n     \"currency\": \"\"\n     }'"
        },
        {
          "id": "QaL2zQTVKREhG-1wiY9z2",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-client-id\", \"string\");\nmyHeaders.append(\"x-signature\", \"string\");\nmyHeaders.append(\"x-timestamp\", \"string\");\nmyHeaders.append(\"x-nonce\", \"string\");\n\nvar raw = JSON.stringify({\n   \"reference\": \"\",\n   \"account_number\": \"\",\n   \"bank_code\": \"\",\n   \"amount\": \"\",\n   \"currency\": \"\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"/client/v1/transfer\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "iAX1wn6n5DRcJRQ3Kzurj",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/client/v1/transfer\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-client-id\"] = \"string\"\nrequest[\"x-signature\"] = \"string\"\nrequest[\"x-timestamp\"] = \"string\"\nrequest[\"x-nonce\"] = \"string\"\nrequest.body = JSON.dump({\n   \"reference\": \"\",\n   \"account_number\": \"\",\n   \"bank_code\": \"\",\n   \"amount\": \"\",\n   \"currency\": \"\"\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "xV9I5vz1FEGoXcLOvPcNo",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/client/v1/transfer\"\n\npayload = json.dumps({\n   \"reference\": \"\",\n   \"account_number\": \"\",\n   \"bank_code\": \"\",\n   \"amount\": \"\",\n   \"currency\": \"\"\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-client-id': 'string',\n   'x-signature': 'string',\n   'x-timestamp': 'string',\n   'x-nonce': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "whNxNNmIlt0-1IGGUuPxx"
    },
    "results": {
      "languages": [
        {
          "id": "KT39ze_2T2Fl1V8nL6AY6",
          "language": "200",
          "code": "// transfer initiated\n{\n  \"data\": {\n    \"id\": \"\"\n  },\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "KT39ze_2T2Fl1V8nL6AY6"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}