List payment transactions and filter by parameters
Return a list of transactions or filter the query using Query parameter values
Filter Parameters
The following filter parameters are available for this query.
| parameter | description |
|---|---|
| transaction_id | Search by transaction_id. String or integer value allowed. Seperate multiple transaction_id's with a comma.
transaction_id is ignored. |
| start_date | Search for transactions beginning on a particular date. Format date as a mm/dd/yy string.
start_date is ignored |
| end_date | Search for transactions ending on a particular date. Format date as a mm/dd/yy string.
end_date is ignored. |
| payment_type | A case-sensitive string to return transactions by specific payment type type.
cc and ach transactions by separating the values with a comma.
payment_type will return only credit card ("cc") transactions. |
| trxn_status | A case-sensitive string to return transactions by specific status type
trxn_status types are returned. |
| amount | Search for a specific amount. Format as a string with whole numbers and up to two decimals as necessary.
amount is ignored. |
| amount_from | Search for a "from amount" to return all transactions equal to or greater than value entered. Format as a string with whole numbers and up to two decimals as necessary.
amount_from is ignored. If value provided here, any value in the amount query parameter will be ignored. |
| amount_to | Search for a "to amount" to return all transactions equal to or less than the value entered. Format as a string with whole numbers and up to two decimals as necessary.
amount_to is ignored. If value provided here, any value in the amount query parameter will be ignored. |
| cardholder_name | Case sensitive string search for transactions by name on credit card. Partial matches will be returned.
cardholder_name is ignored. |
| card_brand | Case sensitive string search for transactions by card brand. Valid values are:
card_brand is ignored. |
| order_id | Case sensitive string search for transactions by order_id. You can return multiple transactions by separating the order_id with a comma.
order_id is ignored. |
| first_6 | Search for transactions matching the first 6 digits of credit card account numbers. You can return multiple transactions by separating the first_6 with a comma.
first_6 is ignored. |
| last_4 | Search for transactions matching the last 4 digits of credit card account numbers. You can return multiple transactions by separating the last_4 with a comma.
last_4 is ignored. |
| limit | The number of results to return when viewing a page. See PAGING below for more details. The default is 40 |
| skip | The number of results to skip before returning results. See PAGING below for more details. The default `is 0 |
Paging
This endpoint provides query filter parameters allowing you to limit the number of results returned when fetching the transaction list.
limit- The number of results to return when viewing a page. For example, setting limit to 20 means that, at most, 20 results will be returned in the request.skip- The number of results to skip before returning results. For example, setting skip to 20 means that the API will discard the first 20 results.
By using these two parameters you can efficiently “page” through results, only returning items that are within the requested bounds.
To demonstrate, let’s use the parameters to display the first page of our transaction results:
GET /transactions?limit=20&skip=0
Since the offset is set to 0, the API will not discard any results. Paired with a limit of 20, we will only see the first 20 results (1 through 20).
GET /transactions?limit=20&skip=20
By setting an offset of 20, the API will discard the first 20 results. Paired again with a limit of 20, we will see the second page of results (21 through 40).
Note:
The Maximum number of transactions returned per API call is 250. If you require more than 250 then you should use the
limitandoffsetparameters above.