Retrieve multiple transaction metrics

GET /transactions/metrics

Description

Retrieve transaction metrics within a specified date range, allowing customization through various parameters.

Path Parameters

Name	Type	Description	Required
from	string (query)	Start date for the metrics period.	Required
to	string (query)	End date for the metrics period.	Required
groupByList	array[string] (query)	Group the metrics by specific criteria. Available values: TENANT, PAYMENT_METHOD, CUSTOMER, ACCOUNT, TYPE, STATUS, SOURCE, CURRENCY, CATEGORY, PAYMENT_CODE, TERMINAL, SUB_SOURCE, SUB_SOURCE_STATUS, PAYMENT, TRANSACTION, REFERENCE, REQUEST.	Optional
metricsMode	string (query)	Metrics mode. Available values: BY_VOLUME.	Optional
filterByStatuses	array[string] (query)	Filter by transaction statuses. Available values: PENDING, APPROVED, REJECTED, REVERSED.	Optional
filterBySources	array[string] (query)	Filter by transaction sources. Available values: CORAL_PAY, AMETA, _9BSP.	Optional
filterByPaymentMethods	array[string] (query)	Filter by payment methods. Available values: USSD, NQR, BANK, WALLET, CARD, PAYLINK, DEPOSIT_DEBIT, DEPOSIT_CREDIT.	Optional
filterByTypes	array[string] (query)	Filter by transaction types. Available values: CREDIT, DEBIT.	Optional
filterByCategories	array[string] (query)	Filter by transaction categories. Available values: Sales, Cash-in, Cash-out, Top-up, Bills, Transfer, Deposit, Withdraw, CHARGE.	Optional
filterByTenantIds	array[string] (query)	Filter by tenant IDs.	Optional
filterByCustomerIds	array[string] (query)	Filter by customer IDs.	Optional
filterByAccountIds	array[string] (query)	Filter by account IDs.	Optional
filterByCurrencies	array[string] (query)	Filter by currencies.	Optional
filterByPaymentCodes	array[string] (query)	Filter by payment codes.	Optional
filterBySubSource	array[string] (query)	Filter by sub-sources.	Optional
filterBySubSourceStatuses	array[string] (query)	Filter by sub-source statuses.	Optional
filterByPaymentIds	array[string] (query)	Filter by payment IDs.	Optional
filterByTerminalIds	array[string] (query)	Filter by terminal IDs.	Optional
filterByRequestIds	array[string] (query)	Filter by request IDs.	Optional
countryCode	string (header)	Country code.	Required

StartFragment

Response Code: 200 - OK

Description

Transaction metric successful.

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

>http://20.87.230.105/platform/wallets/transactions/metrics

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string