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](/documentation/transactions-transfers).
Increase Transactions API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
2 operations
across 2 paths,
and defines 12 schemas.
It is described by OpenAPI 3.1.0, at version 0.0.1.
Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.
2 operations2 paths12 schemas2 GET
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Increase Transactions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Transactions 2
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 [Transaction…
GET
/transactions
List Transactions
list_transactions9 params→ 2004XX5XX
GET
/transactions/{transaction_id}
Retrieve a Transaction
retrieve_a_transaction1 param→ 2004XX5XX
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are card_financial (28 properties), card_settlement (24 properties), card_refund (20 properties), transaction (10 properties). Each schema is shown below with its type and property counts.
inbound_check_adjustment
object
An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21.
3 properties3 required
error
transaction_list
object
A list of Transaction objects.
2 properties2 required
inbound_check_deposit_return_intention
object
An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned.
2 properties2 required
card_refund
object
Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card wit…
20 properties20 required
transaction
object
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 mo…
10 properties10 required
card_settlement
object
Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly…
24 properties24 required
card_financial
object
Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction.
28 properties28 required
check_transfer_deposit
object
An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered.
8 properties8 required
inbound_wire_transfer_reversal
object
An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed.
1 property1 required
inbound_ach_transfer_return_intention
object
An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase.
1 property1 required
card_dispute_financial_visa
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
