This API allows you to retrieve a summary of SoftPOS terminal transactions.

Endpoint

GET https://demo-api.edfapay.com/api/v1/transactions/dashboard/soft-pos-summary/{terminalId}

Authentication

All requests must include a valid X-API-KEY in the request header.

The API key must be sent from the server side and should never be exposed on the client side.

👉 How to generate API key

🔐

Security Note

Always send API requests from your backend.
Do not expose your API Key in frontend applications.

Example Request

curl --location 'https://demo-api.edfapay.com/api/v1/transactions/dashboard/soft-pos-summary/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?days=7' \
--header 'X-API-KEY: YOUR_API_KEY'

Query Parameters

🚧

Important Note

You can obtain the terminalId from the Dashboard under Terminal Details.

The days parameter must be one of the following values: 1, 7, 30, or 360.

Response Example

{
  "code": 200,
  "message": "Success",
  "errorCode": null,
  "data": {
    "dashboardPaymentAmounts": [
      {
        "totalAmount": XX.XX,
        "operationType": "PURCHASE",
        "transactionCount": XX
      }
    ],
    "dashboardOperationType": null,
    "dashboardTopMerchant": null
  }
}

{
  "code": 500,
  "message": "Days should be one of the following values: 1, 7, 30, 360",
  "errorCode": "500",
  "data": null
}