Initiate transfer

1 min

POST

/client/v1/transfer

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.

Header Parameters

X-CLIENT-IDstringrequired
Description
Your client ID
X-SIGNATUREstringrequired
Description
The base64 encoded signature
X-TIMESTAMPstringrequired
Description
The timestamp
X-NONCEstringrequired
Description
The Nonce

Body Parameters

bodyclientApi.TransferRequestrequired
Description
transfer request
- referencestringrequired
- account_numberstringrequired
- bank_codestringrequired
- amountnumberrequired
- currencystringrequired
- narrationstring

Responses

200transfer initiated

clientApi.TransferRequestSuccessful
Description
transfer initiated
- dataobject
  - idstring
- messagestring
  Default
  transfer initiated

curl

curl --request POST \
     --url /client/v1/transfer \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-client-id: string' \
     --header 'x-signature: string' \
     --header 'x-timestamp: string' \
     --header 'x-nonce: string' \
     --data '{
     "reference": "",
     "account_number": "",
     "bank_code": "",
     "amount": "",
     "currency": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-client-id", "string");
myHeaders.append("x-signature", "string");
myHeaders.append("x-timestamp", "string");
myHeaders.append("x-nonce", "string");

var raw = JSON.stringify({
   "reference": "",
   "account_number": "",
   "bank_code": "",
   "amount": "",
   "currency": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("/client/v1/transfer", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/client/v1/transfer")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-client-id"] = "string"
request["x-signature"] = "string"
request["x-timestamp"] = "string"
request["x-nonce"] = "string"
request.body = JSON.dump({
   "reference": "",
   "account_number": "",
   "bank_code": "",
   "amount": "",
   "currency": ""
})

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/client/v1/transfer"

payload = json.dumps({
   "reference": "",
   "account_number": "",
   "bank_code": "",
   "amount": "",
   "currency": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-client-id': 'string',
   'x-signature': 'string',
   'x-timestamp': 'string',
   'x-nonce': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// transfer initiated
{
  "data": {
    "id": ""
  },
  "message": ""
}