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

Payments

Endpoint URL: http://api.prosperent.com/api/payments
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
filterCommissionEarned No float pipe seperated values Filter payments by the amount earned.
filterCommissionReferred No float pipe seperated values Filter payments by the amount earned from referrals.
filterDatePaid No date YYYYMMDD or date range Filter results by the date a payment was paid or range of dates.
filterFeeAmount No float pipe seperated values Filter payments by their fee amounts.
filterPaymentAmount No float pipe seperated values Filter payments by their amounts.
filterPaymentId No int pipe seperated values Filter payments by their unique ID.
filterPaymentNumber No string pipe seperated values 1:1 Filter payments by their number, eg. 1:1 => 1 of 1 payments, 2:3 => 2 of 3 payments, etc.
filterPaymentReferenceId No int pipe seperated values Filter payments by their Reference ID. This ID is the same across multiple payments.
filterPaymentService No string pipe seperated values Filter payments by service.
filterSaleAmount No float pipe seperated values Filter payments by their sale amounts.
filterTotalCommission No float pipe seperated values Filter payments by their total commission amounts.
sortBy No string • paymentId
• paymentReferenceId
• datePaid
• paymentAmount
• saleAmount
• totalCommission
• feeAmount
• commissionEarned
• commissionReferred
• paymentService
• paymentNumber
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 • paymentId
• paymentReferenceId
• datePaid
• paymentService
• paymentNumber
Group results by status.
limit No integer 10 Amount of results you want to receive from the API call.
page No integer 1 Enter a page number to get the next set of results.
enableFacets No boolean true or false or pipe seperated values of facet names Enable or disable facets for the commission data.
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 commission transaction data.
paymentId int The unique ID of the payment.
paymentReferenceId int The reference ID of the payment. This ID is the same across multiple payments.
datePaid date time YYYY-MM-DD hh:mm:ss The date the payment was paid.
paymentAmount float 0.00 The amount of the payment.
saleAmount float 0.00 Total sale amount.
totalCommission float 0.00 The total amount of commissions before fees are subtracted.
feeAmount float 0.00 The amount of the fee for the payment.
commissionEarned float 0.00 Total of commissions earned.
commissionReferred float 0.00 Total of commissions from referrals.
paymentService string The payment service used to make the payment.
paymentNumber string 0:0 The payment number, 1:1 => 1 of 1 payments, 2:3 => 2 of 3 payments, etc.
facets array The facets that are active and their counts and values.
[facetName] array The name of the facet.
count integer The amount of products found for each facet value.
value string The value of the facet, for instance, the merchant name.
extendedFieldValue string Deprecated
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.