Overview #

The Transactions Summary API allows merchants to retrieve a summary of transactions for a specified date range.

The response provides key transaction and balance information, including the total sales amount, number of transactions, available balance, and currency identifier.

Environment #

Endpoint #

POST

/Transaction/GetTransactionSummary

Content Type #

application/json

Request #

Request Headers #

Request Method #

POST

Sample Request #

{
    "merchantId": 74417,
    "dateFrom": "08/05/2024",
    "dateTo": "09/10/2024",
    "secureHashValue": "651697ABFFAAA4A5FC99695E07C4BE695D5AA269E65C28702409715F873AA3C3"
}

Request Parameters #

Date Format: Both dateFrom and dateTo must be provided in dd/MM/yyyy format.

Response #

Successful Response #

When the request is processed successfully, the API returns success: true and response code 00.

Sample Success Response #

{
    "success": true,
    "responseCode": "00",
    "message": "Success",
    "data": {
        "totalSale": 4,
        "totalSaleFormatted": "4.000",
        "numberOfTransactions": 2,
        "availableBalance": 1.69,
        "availableBalanceFormatted": "1.690",
        "currencyId": 512
    },
    "errorList": []
}

Success Response Parameters #

Failure Response #

If the request cannot be processed, the API returns success: false along with a response code and an errorList describing the failure.

Sample Failure Response #

{
    "success": false,
    "responseCode": "02",
    "message": "Merchant Not Found",
    "data": null,
    "errorList": [
        "Merchant Not Found"
    ]
}

Failure Response Parameters #

Common Failure Example #

Merchant Not Found #

{
    "success": false,
    "responseCode": "02",
    "message": "Merchant Not Found",
    "data": null,
    "errorList": [
        "Merchant Not Found"
    ]
}

The Merchant Not Found error indicates that the supplied merchantId could not be identified or is not valid for the requested operation.

Transaction Summary Flow #

The Transactions Summary process follows these steps:

1. The merchant provides the merchantId.
2. The merchant specifies the required transaction date range using dateFrom and dateTo.
3. The merchant generates the required secureHashValue.
4. The request is submitted to the Transaction/GetTransactionSummary endpoint.
5. The API validates the merchant and request parameters.
6. If successful, the API returns the transaction summary for the specified date range.
7. The response includes the total sales amount, transaction count, available balance, and currency identifier.
8. If the request fails, the API returns the relevant response code and error details.