Topup History

Api Endpoint:

This API for Topup History will be a GET request.

{BaseUrl}/payouts/topupHistory?limit=10&page=2

Description

The Topup History API allows a user to retrieve a list of all top-up transactions that have been made to their payout account. This is useful for tracking and managing the funds that have been added to the payout account over time.

Request

Request Header

The request must include the following headers for authentication:

Request Header

{
 "apiKey": "your api key",
 "token": "your token",
 "content-type": "application/json"
}

• apiKey: Your unique API key provided by PayHub.
• token: A token that validates your session or request.
• content-type: Specifies that the request body is in JSON format.

Request Query Parameters

The request can include the following optional query parameters to filter the transactions:

Request Query Parameters

{
 "limit": "number"; 
  "page": "number";
}

• limit: The number of records to return per page e.g., 10, 20, 50.
• page: The page number for pagination e.g., 1, 2, 3.

Possible Responses:

Success Response

A response indicating that the top-up history has been successfully retrieved.

Success Response

{
    "responseCode": 200,
    "responseMessage": "Success",
    "responseData": {
        "records": [
            {
                "usdtAmount": 1.126436781609,
                "inrAmount": 100,
                "conversionRate": 87,
                "timestamp": "2025-09-08T06:32:24.550Z"
            },
            {
                "usdtAmount": 1.126436781609,
                "inrAmount": 100,
                "conversionRate": 87,
                "timestamp": "2025-09-08T05:19:43.549Z"
            },
            {
                "usdtAmount": 1.126436781609,
                "inrAmount": 100,
                "conversionRate": 87,
                "timestamp": "2025-09-08T05:17:02.158Z"
            },
            {
                "usdtAmount": 1.136363636364,
                "inrAmount": 100,
                "conversionRate": 88,
                "timestamp": "2025-09-08T05:12:10.150Z"
            },
            {
                "usdtAmount": 1.126436781609,
                "inrAmount": 100,
                "conversionRate": 87,
                "timestamp": "2025-09-06T11:51:35.987Z"
            },
            {
                "usdtAmount": 1.126954921803,
                "inrAmount": 100,
                "conversionRate": 86.96,
                "timestamp": "2025-09-06T06:51:14.189Z"
            },
            {
                "usdtAmount": 0.11264367816091955,
                "inrAmount": 10,
                "conversionRate": 87,
                "timestamp": "2025-09-06T05:41:20.255Z"
            },
            {
                "usdtAmount": 0,
                "inrAmount": 100,
                "conversionRate": 0,
                "timestamp": "2025-06-18T08:00:10.806Z"
            },
            {
                "usdtAmount": 0,
                "inrAmount": 100,
                "conversionRate": 0,
                "timestamp": "2025-06-18T07:58:21.688Z"
            },
            {
                "usdtAmount": 0,
                "inrAmount": 100,
                "conversionRate": 0,
                "timestamp": "2025-06-18T07:57:11.205Z"
            }
        ],
        "pagination": {
            "totalCount": 44,
            "totalPages": 5,
            "currentPage": 2,
            "limit": 10
        }
    }
}

• responseCode: 200 - Indicates a successful request.
• responseMessage: Success - Confirms that the response is success.
• responseData: Contains the details of the top-up history, including:
  • records: An array of top-up transaction records, where each record includes:
    • usdtAmount: 549.45 - The amount of USDT that was added to the payout account.
    • inrAmount: 50000 - The equivalent amount in INR that was added to the payout account.
    • conversionRate: 91 - The conversion rate used for the top-up transaction.
    • timestamp: "2026-02-16T12:59:01.848Z" - The date and time when the top-up transaction occurred.
  • pagination: Contains information about the pagination of the results, including:
    • totalCount: 44 - The total number of top-up transactions in the history.
    • totalPages: 5 - The total number of pages available based on the limit.
    • currentPage: 2 - The current page number being viewed.
    • limit: 10 - The number of records displayed per page.

Error Response

A response indicating that there was an error retrieving the top-up history.

Invalid API Key

A response indicating that the provided API key is invalid.

Invalid API Key

{
  "responseCode": 401,
  "responseMessage": "Invalid apiKey"
}

• responseCode: 403 - Indicates forbidden access due to an invalid API key.
• responseMessage: Invalid apiKey - A message indicating the provided API key is invalid.

Notes

• Ensure that all required parameters are provided and valid.
• Check the response codes to handle different outcomes appropriately in your application.
• For security, keep your API key and token confidential.

By following this documentation, you can integrate and use the Topup History API effectively in your payment gateway system.