Skip to main content
Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Overview
API Reference
Accounts
Accounts
Account Numbers
Account Transfers
Transactions
Transactions
Pending Transactions
Declined Transactions
Ach Transfers
ACH Transfers
Inbound ACH Transfers
ACH Prenotifications
Check Transfers
Check Transfers
Inbound Check Deposits
Real Time Payments Transfers
Real-Time Payments Transfers
Inbound Real-Time Payments Transfers
Fednow Transfers
FedNow Transfers
Inbound FedNow Transfers
Swift Transfers
Swift Transfers
Wire Transfers
Wire Transfers
Inbound Wire Transfers
Wire Drawdown Requests
Inbound Wire Drawdown Requests
Card Transfers
Card Tokens
Card Push Transfers
Card Validations
Check Deposits
Check Deposits
Lockbox Addresses
Lockbox Recipients
Inbound Mail Items
Cards
Cards
Card Payments
Card Purchase Supplements
Card Disputes
Physical Cards
Digital Card Profiles
Physical Card Profiles
Digital Wallet Tokens
Compliance
Entities
Beneficial Owners
Supplemental Documents
Entity Onboarding Sessions
Programs
Events and Webhooks
Events
Event Subscriptions
Real-Time Decisions
External Accounts
Routing Numbers
External Accounts
Files and Exports
Account Statements
Files
File Links
Exports
OAuth
Groups
OAuth Applications
OAuth Connections
OAuth Tokens
Intrafi
IntraFi Account Enrollments
IntraFi Balances
IntraFi Exclusions
Transactions

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.

Events
Your application can listen to webhooks about this resource. All of the events about Transactions will have the category "transaction.created" .
The Transaction object
Attributes
account_id
string

The identifier for the Account the Transaction belongs to.

More about Accounts.
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 and time at 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.

id
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}"
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const transaction of client.transactions.list()) {
  console.log(transaction.id);
}
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.transactions.list()
page = page.data[0]
print(page.id)
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.transactions.list

puts(page)
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.Transactions.List(context.TODO(), increase.TransactionListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.transactions.TransactionListPage;
import com.increase.api.models.transactions.TransactionListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        TransactionListPage page = client.transactions().list();
    }
}
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.transactions.TransactionListPage
import com.increase.api.models.transactions.TransactionListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val page: TransactionListPage = client.transactions().list()
}
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->transactions->list(
    accountID: 'account_id',
    category: ['in' => ['account_transfer_intention']],
    createdAt: [
      'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    ],
    cursor: 'cursor',
    limit: 1,
    routeID: 'route_id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}
using System;
using Increase.Api;
using Increase.Api.Models.Transactions;

IncreaseClient client = new();

TransactionListParams parameters = new();

var page = await client.Transactions.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
Returns a list response : 
{
  "data": [
    { /* Transaction object */ },
    { /* Transaction object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}
Parameters
account_id
string

Filter Transactions for those belonging to the specified Account.

More about Accounts.
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.

More parameters
cursor
string
limit
integer
created_at.after
string
created_at.before
string
created_at.on_or_after
string
created_at.on_or_before
string
Retrieve a Transaction 
curl \
  --url "${INCREASE_URL}/transactions/transaction_uyrp7fld2ium70oa7oi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const transaction = await client.transactions.retrieve('transaction_uyrp7fld2ium70oa7oi');

console.log(transaction.id);
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
transaction = client.transactions.retrieve(
    "transaction_uyrp7fld2ium70oa7oi",
)
print(transaction.id)
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

transaction = increase.transactions.retrieve("transaction_uyrp7fld2ium70oa7oi")

puts(transaction)
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	transaction, err := client.Transactions.Get(context.TODO(), "transaction_uyrp7fld2ium70oa7oi")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", transaction.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.transactions.Transaction;
import com.increase.api.models.transactions.TransactionRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        Transaction transaction = client.transactions().retrieve("transaction_uyrp7fld2ium70oa7oi");
    }
}
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.transactions.Transaction
import com.increase.api.models.transactions.TransactionRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val transaction: Transaction = client.transactions().retrieve("transaction_uyrp7fld2ium70oa7oi")
}
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $transaction = $client->transactions->retrieve(
    'transaction_uyrp7fld2ium70oa7oi'
  );

  var_dump($transaction);
} catch (APIException $e) {
  echo $e->getMessage();
}
using System;
using Increase.Api;
using Increase.Api.Models.Transactions;

IncreaseClient client = new();

TransactionRetrieveParams parameters = new()
{
    TransactionID = "transaction_uyrp7fld2ium70oa7oi"
};

var transaction = await client.Transactions.Retrieve(parameters);

Console.WriteLine(transaction);
Parameters
transaction_id
string
Required

The identifier of the Transaction to retrieve.

More about Transactions.