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": ""
}
'
[
  {
    "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"