Note: When using this endpoint, you will need your accessKey. Please login to see it

Transactions

Endpoint URL: http://api.prosperent.com/api/transactions
HTTP Method: GET or POST

Request Parameters
Parameter Name Required Data Type Format/Values (Default in bold) Description
accessKey Yes string Log in to view your accessKey Your access key
filterCommissionId No string pipe seperated values Filter transactions by their commissionId.
filterStatus No string pipe seperated values/ new, extended, adjusted, locked, closed or unknown Filter your transactions by their status.
filterCommissionType No string pipe seperated values/ mine or referral Filter commission results by the type of commissions.
filterTransactionDate No date YYYYMMDD or date range Filter transactions by their date.
filterTransactionId No string pipe seperated values Filter transactions by their transactionId.
sortBy No string • commissionId
• paymentAmountAdjustment
• status
• transactionDate
Sort results by the sort method in either ascending or descending order.

Append either of the following to change the sort direction:
asc
• desc
groupBy No string • status Group results by status.
Response Fields
Field Name Data Type Format Description
errors array Will show any errors that may have occured, otherwise it will be empty.
warnings array Will show any warnings that may have occured, otherwise it will be empty.
data array Displays the transaction data.
transactionId string The ID of the transaction, tied to a commissionId.
commissionId string The ID of the commission.
status string The status of the transaction.
paymentAmountAdjustment float 0.00 The amount the payment has been adjusted.
transactionDate date time YYYY-MM-DD h:i:s The date and time the transaction took place.
totalRecords integer 0 Total records for the page of results.
totalRecordsAvailable integer 0 Total records available to you.
totalRecordsFound integer 0 Total records available in our data feed that match your search.