• HTTP

List Transactions

API Docs by APIMATIC

List Transactions
#

  • HTTP

List Transactions
#

❗️ This endpoint is only for subscriptions using Legacy Statement Billing

This method will return the full list of transactions for a Site. Pay close attention to filters and pagination in order to control results. Notes about ID/Date Filters

  • Using since_id and/or max_id is known as creating an “ID Filter”.
  • Using since_date and/or until_date is known as creating a “Date Filter”.
  • You may ONLY make use of either an ID Filter or a Date Filter in any one request.
  • If you specify both an ID Filter and a Date Filter, the Date Filter will be ignored. Pagination Notes Stepping through pages of results by incrementing the page number is typically less performant than using an ID Filter with since_id, especially at high values of page. For example, instead of these successive requests to traverse pagination: GET /transactions.json?page=1&per_page=200 GET /transactions.json?page=2&per_page=200 It is usually faster to use since_id to continue fetching from the last ID you observed: GET /transactions.json?since_id=0&per_page=200&direction=asc GET /transactions.json?since_id=1567&per_page=200&direction=asc In the above example, 1567 is derived by adding 1 to the “last” ID you received from the first request.
GET /transactions.json
Authentication

This endpoint requires BasicAuth

BasicAuth
BasicAuth
Required

Set authorization parameters for BasicAuth

Required
string

The username to use with basic authentication

  • is a required field
Required
string

The password to use with basic authentication

  • is a required field

API Code Playground

Endpoint Arguments
Parameters
Required
Number
Query

Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.

Number
Query

This parameter indicates how many records to fetch in each request.

Default: 20
Constraints: <= 200

Kinds
Query

An array of transaction types. Example: http://example.chargify.com?kinds[]=charge&kinds[]=payment&kinds[]=credit

Number
Query

Returns transactions with an id greater than or equal to the one specified

Number
Query

Returns transactions with an id less than or equal to the one specified

String
Query

(format YYYY-MM-DD) Returns transactions with a created_at timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified

String
Query

(format YYYY-MM-DD) Returns transactions with a created_at timestamp up to and including 11:59:59PM in your site’s time zone on the date specified

Direction
Query

The sort order is based on the created_at timestamp then id for transactions within the same second.

Default: desc

desc
Order By
Query

Using an ID filter (since_id/max_id) will force id order, while using a Date filter (since_date/until_date) will force created_at order. Otherwise, your requested value will be used.

Responses

  • 200

OK

application/json

Type

array<Transactions Json Response 1>

[
  {
    "transaction": {
      "id": 162640678,
      "subscription_id": 15268262,
      "type": "Payment",
      "kind": null,
      "transaction_type": "payment",
      "success": true,
      "amount_in_cents": 1000,
      "memo": "Pookie Test - $10 Basic Plan: Renewal payment",
      "created_at": "2016-11-17T14:03:14-05:00",
      "starting_balance_in_cents": 1000,
      "ending_balance_in_cents": 0,
      "gateway_used": "bogus",
      "gateway_transaction_id": "53433",
      "gateway_order_id": null,
      "payment_id": null,
      "product_id": 3792003,
      "tax_id": null,
      "component_id": null,
      "statement_id": 80669157,
      "customer_id": 14743839,
      "item_name": null,
      "parent_id": null,
      "role": null,
      "card_number": "XXXX-XXXX-XXXX-1",
      "card_expiration": "10/2020",
      "card_type": "bogus",
      "refunded_amount_in_cents": 0
    }
  },
  {
    "transaction": {
      "id": 162640676,
      "subscription_id": 15268319,
      "type": "Payment",
      "kind": null,
      "transaction_type": "payment",
      "success": true,
      "amount_in_cents": 2000,
      "memo": "Pookie Test - $10 Basic Plan: Renewal payment",
      "created_at": "2016-11-17T14:03:14-05:00",
      "starting_balance_in_cents": 2000,
      "ending_balance_in_cents": 0,
      "gateway_used": "bogus",
      "gateway_transaction_id": "53433",
      "gateway_order_id": null,
      "payment_id": null,
      "product_id": 3792003,
      "tax_id": null,
      "component_id": null,
      "statement_id": 80669162,
      "customer_id": 14743895,
      "item_name": null,
      "parent_id": null,
      "role": null,
      "card_number": "XXXX-XXXX-XXXX-1",
      "card_expiration": "10/2020",
      "card_type": "bogus",
      "refunded_amount_in_cents": 0
    }
  }
]
  • Request
  • Response
curl -X GET -G \
  --url 'https://subdomain.chargify.com/transactions.json'  \
  -H 'Accept: application/json' \
  -d 'per_page=20' \
  -d 'direction=desc'