API Reference — Increase

Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see Transactions and Transfers.

The Transaction object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "currency": "USD",
  "description": "INVOICE 2468",
  "id": "transaction_uyrp7fld2ium70oa7oi",
  "route_id": "account_number_v18nkfqm6afpsrvy82b2",
  "route_type": "account_number",
  "source": {
    "category": "inbound_ach_transfer",
    "inbound_ach_transfer": {
      "addenda": null,
      "amount": 100,
      "originator_company_descriptive_date": null,
      "originator_company_discretionary_data": null,
      "originator_company_entry_description": "RESERVE",
      "originator_company_id": "0987654321",
      "originator_company_name": "BIG BANK",
      "receiver_id_number": "12345678900",
      "receiver_name": "IAN CREASE",
      "trace_number": "021000038461022",
      "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev"
    }
  },
  "type": "transaction"
}

Attributes

account_id

string

The identifier for the Account the Transaction belongs to.

amount

integer

The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

created_at

string

The ISO 8601 date on which the Transaction occurred.

currency

enum

The ISO 4217 code for the Transaction's currency. This will match the currency on the Transaction's Account.

description

string

An informational message describing this transaction. Use the fields in source to get more detailed information. This field appears as the line-item on the statement.

string

The Transaction identifier.

route_id

string

Nullable

The identifier for the route this Transaction came through. Routes are things like cards and ACH details.

route_type

enum

Nullable

The type of the route this Transaction came through.

source

dictionary

This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.

type

string

A constant representing the object's type. For this resource it will always be transaction.

List Transactions

curl \
  --url "${INCREASE_URL}/transactions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id

string

Filter Transactions for those belonging to the specified Account.

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

category.in

array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

route_id

string

Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID.

Retrieve a Transaction

curl \
  --url "${INCREASE_URL}/transactions/transaction_uyrp7fld2ium70oa7oi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

transaction_id

string

Required

The identifier of the Transaction to retrieve.