Get Single Transactions

Get Single Disbursement Transactions

curl --request POST \
  --url https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantAccountNumber": 35253486,
  "transactionDate": "2024-01-15",
  "pageNumber": 1,
  "numberOfReturnedRows": 10,
  "isIncremental": false,
  "searchBy": "TransactionReferenceNumber",
  "searchText": ""
}
'

import requests

url = "https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions"

payload = {
    "merchantAccountNumber": 35253486,
    "transactionDate": "2024-01-15",
    "pageNumber": 1,
    "numberOfReturnedRows": 10,
    "isIncremental": False,
    "searchBy": "TransactionReferenceNumber",
    "searchText": ""
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    merchantAccountNumber: 35253486,
    transactionDate: '2024-01-15',
    pageNumber: 1,
    numberOfReturnedRows: 10,
    isIncremental: false,
    searchBy: 'TransactionReferenceNumber',
    searchText: ''
  })
};

fetch('https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'merchantAccountNumber' => 35253486,
    'transactionDate' => '2024-01-15',
    'pageNumber' => 1,
    'numberOfReturnedRows' => 10,
    'isIncremental' => false,
    'searchBy' => 'TransactionReferenceNumber',
    'searchText' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions"

	payload := strings.NewReader("{\n  \"merchantAccountNumber\": 35253486,\n  \"transactionDate\": \"2024-01-15\",\n  \"pageNumber\": 1,\n  \"numberOfReturnedRows\": 10,\n  \"isIncremental\": false,\n  \"searchBy\": \"TransactionReferenceNumber\",\n  \"searchText\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantAccountNumber\": 35253486,\n  \"transactionDate\": \"2024-01-15\",\n  \"pageNumber\": 1,\n  \"numberOfReturnedRows\": 10,\n  \"isIncremental\": false,\n  \"searchBy\": \"TransactionReferenceNumber\",\n  \"searchText\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchantAccountNumber\": 35253486,\n  \"transactionDate\": \"2024-01-15\",\n  \"pageNumber\": 1,\n  \"numberOfReturnedRows\": 10,\n  \"isIncremental\": false,\n  \"searchBy\": \"TransactionReferenceNumber\",\n  \"searchText\": \"\"\n}"

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

[
  {
    "beneficiaryAccountNumber": "9876543210",
    "beneficiaryName": "Grace Banda",
    "connectorName": "Standard Bank",
    "transactionAmount": 1000000,
    "currencyCode": "MWK",
    "transactionStatusCode": "S",
    "transactionStatusName": "Successful",
    "transactionDescription": "Salary payment",
    "transactionReferenceNumber": "D250713MGGGY",
    "transactionDate": "2024-01-15"
  },
  {
    "beneficiaryAccountNumber": "8765432109",
    "beneficiaryName": "Jane Chidothi",
    "connectorName": "FDH Bank Limited",
    "transactionAmount": 500000,
    "currencyCode": "MWK",
    "transactionStatusCode": "P",
    "transactionStatusName": "Pending",
    "transactionDescription": "Bonus payment",
    "transactionReferenceNumber": "D250713MGGGY",
    "transactionDate": "2024-01-15"
  }
]

""

POST

disbursements

single

getTransactions

Get Single Disbursement Transactions

curl --request POST \
  --url https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantAccountNumber": 35253486,
  "transactionDate": "2024-01-15",
  "pageNumber": 1,
  "numberOfReturnedRows": 10,
  "isIncremental": false,
  "searchBy": "TransactionReferenceNumber",
  "searchText": ""
}
'

import requests

url = "https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions"

payload = {
    "merchantAccountNumber": 35253486,
    "transactionDate": "2024-01-15",
    "pageNumber": 1,
    "numberOfReturnedRows": 10,
    "isIncremental": False,
    "searchBy": "TransactionReferenceNumber",
    "searchText": ""
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    merchantAccountNumber: 35253486,
    transactionDate: '2024-01-15',
    pageNumber: 1,
    numberOfReturnedRows: 10,
    isIncremental: false,
    searchBy: 'TransactionReferenceNumber',
    searchText: ''
  })
};

fetch('https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'merchantAccountNumber' => 35253486,
    'transactionDate' => '2024-01-15',
    'pageNumber' => 1,
    'numberOfReturnedRows' => 10,
    'isIncremental' => false,
    'searchBy' => 'TransactionReferenceNumber',
    'searchText' => ''
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions"

	payload := strings.NewReader("{\n  \"merchantAccountNumber\": 35253486,\n  \"transactionDate\": \"2024-01-15\",\n  \"pageNumber\": 1,\n  \"numberOfReturnedRows\": 10,\n  \"isIncremental\": false,\n  \"searchBy\": \"TransactionReferenceNumber\",\n  \"searchText\": \"\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantAccountNumber\": 35253486,\n  \"transactionDate\": \"2024-01-15\",\n  \"pageNumber\": 1,\n  \"numberOfReturnedRows\": 10,\n  \"isIncremental\": false,\n  \"searchBy\": \"TransactionReferenceNumber\",\n  \"searchText\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.api.onekhusa.com/sandbox/v1/disbursements/single/getTransactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchantAccountNumber\": 35253486,\n  \"transactionDate\": \"2024-01-15\",\n  \"pageNumber\": 1,\n  \"numberOfReturnedRows\": 10,\n  \"isIncremental\": false,\n  \"searchBy\": \"TransactionReferenceNumber\",\n  \"searchText\": \"\"\n}"

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

[
  {
    "beneficiaryAccountNumber": "9876543210",
    "beneficiaryName": "Grace Banda",
    "connectorName": "Standard Bank",
    "transactionAmount": 1000000,
    "currencyCode": "MWK",
    "transactionStatusCode": "S",
    "transactionStatusName": "Successful",
    "transactionDescription": "Salary payment",
    "transactionReferenceNumber": "D250713MGGGY",
    "transactionDate": "2024-01-15"
  },
  {
    "beneficiaryAccountNumber": "8765432109",
    "beneficiaryName": "Jane Chidothi",
    "connectorName": "FDH Bank Limited",
    "transactionAmount": 500000,
    "currencyCode": "MWK",
    "transactionStatusCode": "P",
    "transactionStatusName": "Pending",
    "transactionDescription": "Bonus payment",
    "transactionReferenceNumber": "D250713MGGGY",
    "transactionDate": "2024-01-15"
  }
]

""

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

Accept-Language

string

default:en

Preferred language for the response

Body

application/json

merchantAccountNumber

integer

required

A unique identifier for the merchant account.

Required range: 10000000 <= x <= 99999999

Example:

35253486

transactionDate

string<date>

required

The date to filter transactions (YYYY-MM-DD format)

Example:

"2024-01-15"

pageNumber

integer

required

Page number for pagination (starts from 1)

Required range: x >= 1

Example:

1

numberOfReturnedRows

integer

required

Number of records per page

Required range: x >= 1

Example:

10

isIncremental

boolean

required

If true, includes previous pages; if false, only current page

Example:

false

searchBy

enum<string>

required

Field to search by

Available options:

TransactionReferenceNumber,

SourceReferenceNumber,

BeneficiaryAccountNumber,

BeneficiaryName

Example:

"TransactionReferenceNumber"

searchText

string

Text to search for (case-insensitive)

Example:

""

Response

Success Response (200 OK)

beneficiaryAccountNumber

string

The recipient's account number

Example:

"9876543210"

beneficiaryName

string

The recipient's name

Example:

"John Phiri"

connectorName

string

Name of the payment connector used

Example:

"Standard Bank"

transactionAmount

number<decimal>

The disbursed amount

Example:

1000000

currencyCode

string

A three-letter ISO 4217 code that identifies the currency used in the transaction

Example:

"MWK"

transactionStatusCode

string

Current status code of the transaction

Example:

"S"

transactionStatusName

string

Human-readable status description

Example:

"Successful"

transactionDescription

string

Description of the transaction

Example:

"Salary payment"

transactionReferenceNumber

string

Unique transaction reference number

Example:

"D250713MGGGY"

transactionDate

string<date>

Date and time when the transaction was initiated

Example:

"2024-01-15"

Getting Started

Accept Payments

Disbursements

Bill Payments

Merchants

Disputes

Security

Supporting APIs

Authorizations

Headers

Body

Response