Merchant Metrics

This API allows partners to retrieve total fees of a particular merchant given its merchant ID.

Retrieve fees or pending payout for a particular merchant given its ID

GET https://<PayEngine-host>/api/merchant/:id/metrics/:metricType

Request

Path Parameters

Name	Type	Description
id*	string	Merchant ID
metricType*	string	Type of metrics 1. fees 2. pending-payout

Query Parameters

Name	Type	Description
from_date	date	When retrieving the fees metric type, by default, the fees will be calculated from the date when the merchant is activated. If the fees needs to be retrieved from a specific date, then provide the date in mm-dd-yyyy format
to_date	date	When retrieving the fees metric type, by default, the fees will be calculated till the current date. If the fees needs to be retrieved till a specific date, then provide the date in mm-dd-yyyy format

200

Field Definitions

Field Name	Type	Description	Required?
data.total_fees	string	Fees for the merchant from the date specified in from_date. If from_date is not specified, then it will be fees from the date of merchant activation	Required
data.pending_payout	string	Merchant ID	Required

Sample Request

curl --location --request GET '<API_HOST>/api/merchant/d6399869-747c-4537-9c04-f81ce2a6c5eb/metrics/pending-payout?from_date=01-01-2024' \
--header 'Authorization: Basic <API_KEY>'

Sample Response - Fees

{
    "data": {
        "total_fees": "290239.13"
    }
}

Sample Response - Pending Payout

{
    "data": {
        "pending_payout_amount": "909.12"
    }
}