Skip to main content
Vindicia Knowledge Center

List all transactions

List all transactions

Retrieves all transactions. To limit the potentially large return size, it is recommended that the account or subscription query parameters be used to filter, in addition to pagination.

Route (URL) Parameters

None.

Query Parameters

Parameter Default Description Required
limit 20 A limit on the number of objects to be returned, between 1 and 100. No
starting_after none A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. No
ending_before none A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. No
include_children false Indicates whether or not to return any existing child accounts’ transactions for a given returned Subscription/account combination.  
account none Limit the transaction list to a specified account - if specified, all Transactions associated with that Account. No
subscription none Limit the transaction list to a specified subscription - if specified, all Transactions associated with that subscription. No

Accepts

None.

Returns

JSON A list array with a data property that contains an array of up to limit Transactions, starting after the specified starting_after Transaction (or ending before the specified ending_before Transaction).. Each entry in the array is a full Transaction object. If no more Transactions are available, the resulting array will be empty. This request should never throw an error.

A list of Transaction objects matching the query. Also:

  • “total_count”: Integer count of the number of Transactions in the returned list.

  • “url”: The query string provided in the request

  • “next”: The route (partial URL) to the next Transaction object (string to select the “next”); included id should match that of the last object returned here

  • “previous”: The route (partial URL) to the previous Transaction object (string to select the “previous”); included id should match that of the first object returned here

  • cURL
  • Java
Example Request
curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.prodtest.vindicia.com/transactions?subscription=sub_1234x"
          
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
            "object": "Transaction",
            "id": "FLX200001621",
            "vid": "d137d38973040467ed65b1d7c331a22ef14605c8",
            "created": "2016-05-31T15:12:28-07:00",
            "amount": 10.98,
            "currency": "USD",
            "account": {`...`},
            "source_payment_method": {`...`},
            "status_log": {`...`},
            "payment_processor": "Test",
            "payment_processor_transaction_id": "FLX200001621",
            "shipping_address": {`...`},
            "metadata": {
                "vin:RetryNumber": "0",
                "vin:recurring": "1",
                "vin:BillingCycle": "0"
            },
            "items": {
                "object": "List",
                "data": [
                    {`...transactionitem...`},
                    {`...transactionitem...`},
                    {`...transactionitem...`},
                    {`...transactionitem...`}
                ],
                "total_count": 4
            },
            "sales_tax_address": {`...`},
            "subscription_sequence": 1,
            "billing_plan_sequence": 1,
            "original_billing_date": "2016-05-27T00:00:00-07:00",
            "billing_attempt": 0,
            "subscription": {
                "object": "Subscription",
                "id": "sub_1234x",
                "vid": "796db5f7f7a1dea312f6c7e1393aebec1f1ecf1b"
            },
            "to_be_captured": true
        }
    ],
    "total_count": 1,
    "url": "/transactions?subscription=sub_1234x",
    "next": "/transactions?subscription=sub_1234x&starting_after=FLX200001621",
    "previous": "/transactions?subscription=sub_1234x&starting_before=FLX200001621"
}
import com.vindicia.client.CashBox;
CashBox.apiKey = "acaff38d462f9430d5cbcbaf:a575771fc679b9de";
Map<string,> params = new HashMap<string,>();
params.put("subscription",  sub_1234x);
transaction.list(params);
          
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
            "object": "Transaction",
            "id": "FLX200001621",
            "vid": "d137d38973040467ed65b1d7c331a22ef14605c8",
            "created": "2016-05-31T15:12:28-07:00",
            "amount": 10.98,
            "currency": "USD",
            "account": {`...`},
            "source_payment_method": {`...`},
            "status_log": {`...`},
            "payment_processor": "Test",
            "payment_processor_transaction_id": "FLX200001621",
            "shipping_address": {`...`},
            "metadata": {
                "vin:RetryNumber": "0",
                "vin:recurring": "1",
                "vin:BillingCycle": "0"
            },
            "items": {
                "object": "List",
                "data": [
                    {`...transactionitem...`},
                    {`...transactionitem...`},
                    {`...transactionitem...`},
                    {`...transactionitem...`}
                ],
                "total_count": 4
            },
            "sales_tax_address": {`...`},
            "subscription_sequence": 1,
            "billing_plan_sequence": 1,
            "original_billing_date": "2016-05-27T00:00:00-07:00",
            "billing_attempt": 0,
            "subscription": {
                "object": "Subscription",
                "id": "sub_1234x",
                "vid": "796db5f7f7a1dea312f6c7e1393aebec1f1ecf1b"
            },
            "to_be_captured": true
        }
    ],
    "total_count": 1,
    "url": "/transactions?subscription=sub_1234x",
    "next": "/transactions?subscription=sub_1234x&starting_after=FLX200001621",
    "previous": "/transactions?subscription=sub_1234x&starting_before=FLX200001621"
}
          

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top