Description
Gets a detailed list of Reseller's Transactions, matching the search criteria.
Parameters
| Name |
Data Type |
Required / Optional |
Description |
|---|
| auth-userid |
Integer |
Required |
Authentication Parameter |
| api-key |
String |
Required |
Authentication Parameter |
| 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 |
| balance-type |
String |
Optional |
Payment status for the Transaction. Possible values can be:
If this parameter is not included in the API call, all Transactions (balanced as well as unbalanced) will be fetched.
|
| 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 |
| no-of-records |
Integer |
Required |
Number of Transactions to be fetched |
| page-no |
Integer |
Required |
Page number for which details are to be fetched |
| 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 transaction-id; it will fetch the first 30 Transactions which match the search criteria sorted by transaction-id. If page-no is 2, no-of-records is 30 and order-by is transaction-id; it will fetch the second batch of 30 Transactions sorted by transaction-id.
|
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/billing/my-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Response
Returns a hash map of the Reseller's Transactions containing the below details:
-
Transaction Id (transid)
-
Transaction Date (transactiondate)
-
Product Key (key)
-
Transaction Type (type)
-
Transaction Description (description)
-
Whether Transaction is Greedy (greedy)
-
Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)
-
Reseller Chain by RID (parentkey)
In case of any errors, a status key with value as ERROR along with an error message will be returned.