Overview

This page contains the logic that governs the retrieval of transaction and dispute statistics

Get Total Sales

GET {{url}}/v2/developer/total/sales

Return the total amount processed for a transaction with is_deposit_made set to true base on the value set in the request query variable currency

Query Parameters

Name	Type	Description
currency*	String	Currency code NGN, GHS

Headers

Name	Type	Description
Authorization*	String	"Bearer <YOUR_API_KEY>"

200: OK If successful

{
    "status": true,
    "code": 200,
    "message": "total amount processed retrieved successfully.",
    "data": 5000
}

Get Total Revenue

GET {{url}}/v2/developer/total/revenue

Return total revenue for completed transaction base on the currency specified in the request query currency

Query Parameters

Name	Type	Description
currency*	String	Currency code e.g NGN, GHS

Headers

Name	Type	Description
Authorization*	String	"Bearer <YOUR_API_KEY>"

Get Transaction Status Stats

GET {{url}}/v2/developer/total/transactions

Return total number of transaction and statuses pending, completed and cancelled

Headers

Name	Type	Description
Authorization*	String	"Bearer <YOUR_API_KEY>"

200: OK If successful

{
    "status": true,
    "code": 200,
    "message": "Transaction statistics retrieved successfully.",
    "data": {
        "total": 12,
        "pending": 10,
        "completed": 2,
        "cancelled": 0
    }
}

Get Dispute Status Stats

GET {{url}}/v2/developer/total/disputes

Return total number of dispute and statuses pending, resolved and refunded

Headers

Name	Type	Description
Authorization*	String	"Bearer <YOUR_API_KEY>"

200: OK If successful

{
    "status": true,
    "code": 200,
    "message": "Dispute statistics retrieved successfully.",
    "data": {
        "totalDisputes": 2,
        "pendingDisputes": 1,
        "resolvedDisputes": 0,
        "refundedDisputes": 1
    }
}