POST
/
core
/
MerchantAnalytics
/
GetConnectorSummarySumMetrics
Get Connector Summary By Sum
curl --request POST \
  --url https://api.onekhusa.com/sandbox/v1/core/MerchantAnalytics/GetConnectorSummarySumMetrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Merchant-Account-Number: <x-merchant-account-number>' \
  --header 'X-Organisation-Id: <x-organisation-id>' \
  --data '{
  "merchantAccountNumber": 35253486,
  "summaryType": "D",
  "fromDate": "2024-01-01T00:00:00Z",
  "toDate": "2024-01-31T23:59:59Z"
}'
[
  {
    "connectorName": "National Bank of Malawi",
    "currencyCode": "MWK",
    "successfulTransactions": 2500000,
    "failedTransactions": 75000,
    "totalTransactions": 2575000
  },
  {
    "connectorName": "FDH Bank Limited",
    "currencyCode": "MWK",
    "successfulTransactions": 1850000,
    "failedTransactions": 25000,
    "totalTransactions": 1875000
  },
  {
    "connectorName": "Airtel Money",
    "currencyCode": "MWK",
    "successfulTransactions": 3750000,
    "failedTransactions": 125000,
    "totalTransactions": 3875000
  }
]

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <Token>, where <Token> is your access token.

Headers

ā€‹
X-Organisation-Id
string
required

The organization identifier

ā€‹
X-Merchant-Account-Number
string
required

The merchant account number

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json
ā€‹
merchantAccountNumber
integer
required

The merchant account number

Required range: 10000000 <= x <= 99999999
Example:

35253486

ā€‹
summaryType
string
required

The type of summary (e.g., "D" for Disbursement and "C" for Collections)

Example:

"D"

ā€‹
fromDate
string<date-time>
required

Start date for the metrics period (ISO 8601 format)

Example:

"2024-01-01T00:00:00Z"

ā€‹
toDate
string<date-time>
required

End date for the metrics period (ISO 8601 format)

Example:

"2024-01-31T23:59:59Z"

Response

200 - application/json

Success Response (200)

ā€‹
connectorName
string

The name of the payment connector

Example:

"National Bank of Malawi"

ā€‹
currencyCode
string

The currency code for the transactions

Example:

"MWK"

ā€‹
successfulTransactions
number

Total amount of successful transactions

Example:

2500000

ā€‹
failedTransactions
number

Total amount of failed transactions

Example:

75000

ā€‹
totalTransactions
number

Total amount of all transactions

Example:

2575000