Home » Reseller Guides » Reseller API Guide » HTTP API » API Requests » Common » Billing

Search Transactions Of Customers

Description

Gets a detailed list of the transactions of Customers, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
no-of-records Integer Required Number of transactions to be fetched
page-no Integer Required Page number for which details are to be fetched
customer-id Array of Integers Optional Customer Id(s) whose transactions details need to be fetched
username Array of Strings Optional Username of the customers whose transaction details need to be fetched
transaction-type Array of Strings Optional Type of the transactions. Possible values can be credit, debit, invoice, receipt.
transaction-key String Optional Transaction key. Possible value can be manually or systemgenerated.
transaction-id Array of Integers Optional Transaction Ids
transaction-description String Optional Transaction description
amt-range-start Integer Optional Lowest amount in the range of transactions you intend to list
amt-range-end Integer Optional Highest amount in the range of transactions you intend to list
transaction-date-start String Optional UNIX TimeStamp for listing of transactions whose Creation Date is greater than transaction-date-start
transaction-date-end String Optional UNIX TimeStamp for listing of transactions whose Creation Date is less than transaction-date-end
order-by Array of Strings Optional One or more parameters by which you want to sort the transactions.

Example: If page-no is 1, no-of-records is 30 and order-by is customerid; it will fetch the first 30 transactions which suit the search criteria sorted by customerid. If page-no is 2, no-of-records is 30 and order-by is customerid; it will fetch the second batch of 30 transactions sorted by customerid

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/billing/customer-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns the details of the customer transactions which match the search criteria.