POST
/
core
/
MerchantAnalytics
/
GetConnectorSummarySumMetrics
Get Connector Summary By Sum
curl --request POST \
  --url https://dev.api.onekhusa.com/sandbox/v1/core/MerchantAnalytics/GetConnectorSummarySumMetrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchantAccountNumber": 35253486,
  "summaryType": "D",
  "fromDate": "2024-01-01",
  "toDate": "2024-01-31"
}
'
[
  {
    "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 , where is your access token.

Headers

​
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>
required

Start date for the metrics period (ISO 8601 format)

Example:

"2024-01-01"

​
toDate
string<date>
required

End date for the metrics period (ISO 8601 format)

Example:

"2024-01-31"

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<decimal>

Total amount of successful transactions

Example:

2500000

​
failedTransactions
number<decimal>

Total amount of failed transactions

Example:

75000

​
totalTransactions
number<decimal>

Total amount of all transactions

Example:

2575000