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).
openapi: 3.1.0
info:
description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
title: Increase Account Numbers Transactions API
version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: 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).
name: Transactions
paths:
/transactions:
get:
operationId: list_transactions
parameters:
- in: query
name: cursor
required: false
schema:
description: Return the page of entries after this one.
type: string
x-documentation-priority: low
- in: query
name: limit
required: false
schema:
description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
minimum: 1
type: integer
x-documentation-priority: low
- in: query
name: account_id
required: false
schema:
description: Filter Transactions for those belonging to the specified Account.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
- in: query
name: created_at.after
required: false
schema:
description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: created_at.before
required: false
schema:
description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: created_at.on_or_after
required: false
schema:
description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: created_at.on_or_before
required: false
schema:
description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: category.in
required: false
schema:
description: 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`.
items:
enum:
- account_transfer_intention
- ach_transfer_intention
- ach_transfer_rejection
- ach_transfer_return
- cashback_payment
- card_dispute_acceptance
- card_dispute_financial
- card_dispute_loss
- card_refund
- card_settlement
- card_financial
- card_revenue_payment
- check_deposit_acceptance
- check_deposit_return
- fednow_transfer_acknowledgement
- check_transfer_deposit
- fee_payment
- inbound_ach_transfer
- inbound_ach_transfer_return_intention
- inbound_check_deposit_return_intention
- inbound_check_adjustment
- inbound_fednow_transfer_confirmation
- inbound_real_time_payments_transfer_confirmation
- inbound_wire_reversal
- inbound_wire_transfer
- inbound_wire_transfer_reversal
- interest_payment
- internal_source
- real_time_payments_transfer_acknowledgement
- sample_funds
- wire_transfer_intention
- swift_transfer_intention
- swift_transfer_return
- card_push_transfer_acceptance
- account_revenue_payment
- blockchain_onramp_transfer_intention
- blockchain_offramp_transfer_settlement
- other
type: string
x-enum-descriptions:
- 'Account Transfer Intention: details will be under the `account_transfer_intention` object.'
- 'ACH Transfer Intention: details will be under the `ach_transfer_intention` object.'
- 'ACH Transfer Rejection: details will be under the `ach_transfer_rejection` object.'
- 'ACH Transfer Return: details will be under the `ach_transfer_return` object.'
- 'Cashback Payment: details will be under the `cashback_payment` object.'
- 'Legacy Card Dispute Acceptance: details will be under the `card_dispute_acceptance` object.'
- 'Card Dispute Financial: details will be under the `card_dispute_financial` object.'
- 'Legacy Card Dispute Loss: details will be under the `card_dispute_loss` object.'
- 'Card Refund: details will be under the `card_refund` object.'
- 'Card Settlement: details will be under the `card_settlement` object.'
- 'Card Financial: details will be under the `card_financial` object.'
- 'Card Revenue Payment: details will be under the `card_revenue_payment` object.'
- 'Check Deposit Acceptance: details will be under the `check_deposit_acceptance` object.'
- 'Check Deposit Return: details will be under the `check_deposit_return` object.'
- 'FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.'
- 'Check Transfer Deposit: details will be under the `check_transfer_deposit` object.'
- 'Fee Payment: details will be under the `fee_payment` object.'
- 'Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` object.'
- 'Inbound ACH Transfer Return Intention: details will be under the `inbound_ach_transfer_return_intention` object.'
- 'Inbound Check Deposit Return Intention: details will be under the `inbound_check_deposit_return_intention` object.'
- 'Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.'
- 'Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.'
- 'Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.'
- 'Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object.'
- 'Inbound Wire Transfer Intention: details will be under the `inbound_wire_transfer` object.'
- 'Inbound Wire Transfer Reversal Intention: details will be under the `inbound_wire_transfer_reversal` object.'
- 'Interest Payment: details will be under the `interest_payment` object.'
- 'Internal Source: details will be under the `internal_source` object.'
- 'Real-Time Payments Transfer Acknowledgement: details will be under the `real_time_payments_transfer_acknowledgement` object.'
- 'Sample Funds: details will be under the `sample_funds` object.'
- 'Wire Transfer Intention: details will be under the `wire_transfer_intention` object.'
- 'Swift Transfer Intention: details will be under the `swift_transfer_intention` object.'
- 'Swift Transfer Return: details will be under the `swift_transfer_return` object.'
- 'Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.'
- 'Account Revenue Payment: details will be under the `account_revenue_payment` object.'
- 'Blockchain On-Ramp Transfer Intention: details will be under the `blockchain_onramp_transfer_intention` object.'
- 'Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.'
- The Transaction was made for an undocumented or deprecated reason.
type: array
x-documentation-priority: default
explode: false
- in: query
name: route_id
required: false
schema:
description: Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID.
type: string
x-documentation-priority: default
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/transaction_list'
description: Transaction List
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: List Transactions
x-sandbox-only: false
x-tag: Transactions
tags:
- Transactions
/transactions/{transaction_id}:
get:
operationId: retrieve_a_transaction
parameters:
- example: transaction_uyrp7fld2ium70oa7oi
in: path
name: transaction_id
required: true
schema:
description: The identifier of the Transaction to retrieve.
type: string
x-documentation-priority: default
x-id-reference-to: Transactions
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/transaction'
description: Transaction
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Retrieve a Transaction
x-sandbox-only: false
x-tag: Transactions
tags:
- Transactions
components:
schemas:
inbound_check_adjustment:
additionalProperties: true
description: An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21.
example:
adjusted_transaction_id: transaction_uyrp7fld2ium70oa7oi
amount: 1750
reason: late_return
properties:
adjusted_transaction_id:
description: The ID of the transaction that was adjusted.
type: string
x-documentation-priority: default
x-id-reference-to: Transactions
amount:
description: The amount of the check adjustment.
type: integer
x-documentation-priority: default
reason:
description: The reason for the adjustment.
enum:
- late_return
- wrong_payee_credit
- adjusted_amount
- non_conforming_item
- paid
type: string
x-documentation-priority: default
x-enum-descriptions:
- The return was initiated too late and the receiving institution has responded with a Late Return Claim.
- The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
- The check was deposited with a different amount than what was written on the check.
- The recipient was not able to process the check. This usually happens for e.g., low quality images.
- The check has already been deposited elsewhere and so this is a duplicate.
required:
- adjusted_transaction_id
- amount
- reason
title: Inbound Check Adjustment
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Inbound Check Adjustments
error:
anyOf:
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 404
type: integer
title:
type: string
type:
enum:
- api_method_not_found_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- environment_mismatch_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
resource_id:
description: ''
type: string
x-documentation-priority: default
status:
enum:
- 409
type: integer
title:
type: string
type:
enum:
- idempotency_key_already_used_error
type: string
required:
- type
- title
- detail
- status
- resource_id
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- insufficient_permissions_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 500
type: integer
title:
type: string
type:
enum:
- internal_server_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
reason:
description: ''
enum:
- deleted_credential
- expired_credential
- ip_not_allowed
- no_credential
- no_header
- no_api_access
- wrong_environment
type: string
x-documentation-priority: default
x-enum-descriptions:
- deleted_credential
- expired_credential
- ip_not_allowed
- no_credential
- no_header
- no_api_access
- wrong_environment
status:
enum:
- 401
type: integer
title:
type: string
type:
enum:
- invalid_api_key_error
type: string
required:
- type
- title
- detail
- status
- reason
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 409
type: integer
title:
type: string
type:
enum:
- invalid_operation_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
errors:
description: All errors related to parsing the request parameters.
items:
additionalProperties: true
properties: {}
title: ErrorsElement
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: ErrorsElements
type: array
x-documentation-priority: default
status:
enum:
- 400
type: integer
title:
type: string
type:
enum:
- invalid_parameters_error
type: string
required:
- type
- title
- detail
- status
- errors
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 400
type: integer
title:
type: string
type:
enum:
- malformed_request_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 404
type: integer
title:
type: string
type:
enum:
- object_not_found_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- private_feature_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
retry_after:
anyOf:
- description: ''
type: integer
x-documentation-priority: default
- type: 'null'
status:
enum:
- 429
type: integer
title:
type: string
type:
enum:
- rate_limited_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
transaction_list:
additionalProperties: true
description: A list of Transaction objects.
example:
data:
- 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
next_cursor: v57w5d
properties:
data:
description: The contents of the list.
items:
$ref: '#/components/schemas/transaction'
type: array
x-documentation-priority: default
next_cursor:
anyOf:
- description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
type: string
x-documentation-priority: default
- type: 'null'
required:
- data
- next_cursor
title: Transaction List
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Transaction Lists
inbound_check_deposit_return_intention:
additionalProperties: true
description: An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned.
example:
inbound_check_deposit_id: inbound_check_deposit_zoshvqybq0cjjm31mra
transfer_id: check_transfer_30b43acfu9vw8fyc4f5
properties:
inbound_check_deposit_id:
description: The ID of the Inbound Check Deposit that is being returned.
type: string
x-documentation-priority: default
x-id-reference-to: Inbound Check Deposits
transfer_id:
anyOf:
- description: The identifier of the Check Transfer object that was deposited.
type: string
x-documentation-priority: default
x-id-reference-to: Check Transfers
- type: 'null'
required:
- inbound_check_deposit_id
- transfer_id
title: Inbound Check Deposit Return Intention
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Inbound Check Deposit Return Intentions
card_refund:
additionalProperties: true
description: 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 without relation to a transaction.
example:
amount: 100
card_payment_id: card_payment_nd3k2kacrqjli8482ave
cashback: null
currency: USD
id: card_refund_imgc2xwplh6t4r3gn16e
interchange:
amount: '0.137465'
code: '271'
currency: USD
merchant_acceptor_id: '5665270011000168'
merchant_category_code: '5734'
merchant_city: New York
merchant_country: US
merchant_name: AMAZON.COM
merchant_postal_code: '10045'
merchant_state: NY
network_identifiers:
acquirer_business_id: '69650702'
acquirer_reference_number: '83163715445437604865089'
authorization_identification_response: ABC123
transaction_id: '627199945183184'
presentment_amount: 100
presentment_currency: USD
purchase_details:
car_rental: null
customer_reference_identifier: '51201'
local_tax_amount: null
local_tax_currency: usd
lodging:
check_in_date: '2023-07-20'
daily_room_rate_amount: 1000
daily_room_rate_currency: usd
extra_charges: restaurant
folio_cash_advances_amount: 0
folio_cash_advances_currency: usd
food_beverage_charges_amount: 0
food_beverage_charges_currency: usd
no_show_indicator: no_show
prepaid_expenses_amount: 0
prepaid_expenses_currency: usd
room_nights: 1
total_room_tax_amount: 100
total_room_tax_currency: usd
total_tax_amount: 100
total_tax_currency: usd
national_tax_amount: null
national_tax_currency: usd
purchase_identifier: '10203'
purchase_identifier_format: order_number
travel: null
scheme_fees:
- amount: '0.137465'
created_at: '2020-01-31T23:59:59Z'
currency: USD
fee_type: visa_corporate_acceptance_fee
fixed_component: null
variable_rate: '0.0002'
transaction_id: transaction_uyrp7fld2ium70oa7oi
type: card_refund
properties:
amount:
description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.
type: integer
x-documentation-priority: default
card_payment_id:
description: The ID of the Card Payment this transaction belongs to.
type: string
x-documentation-priority: default
x-id-reference-to: Card Payments
cashback:
anyOf:
- additionalProperties: false
description: Cashback debited for this transaction, if eligible. Cashback is paid out in aggregate, monthly.
example:
amount: '0.137465'
currency: USD
properties:
amount:
description: The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds).
pattern: ^-?\d+(\.\d+)?$
type: string
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
required:
- amount
- currency
title: Card Refund Cashback
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Cashbacks
- type: 'null'
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
id:
description: The Card Refund identifier.
type: string
x-documentation-priority: default
x-id-reference-to: Card Refunds
interchange:
anyOf:
- additionalProperties: false
description: Interchange assessed as a part of this transaction.
example:
amount: '0.137465'
code: '271'
currency: USD
properties:
amount:
description: The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds).
pattern: ^-?\d+(\.\d+)?$
type: string
x-documentation-priority: default
code:
anyOf:
- description: The card network specific interchange code.
type: string
x-documentation-priority: default
- type: 'null'
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
required:
- amount
- currency
- code
title: Card Refund Card Interchange
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Card Interchanges
- type: 'null'
merchant_acceptor_id:
description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
type: string
x-documentation-priority: default
merchant_category_code:
description: The 4-digit MCC describing the merchant's business.
type: string
x-documentation-priority: default
merchant_city:
description: The city the merchant resides in.
type: string
x-documentation-priority: default
merchant_country:
description: The country the merchant resides in.
type: string
x-documentation-priority: default
merchant_name:
description: The name of the merchant.
type: string
x-documentation-priority: default
merchant_postal_code:
anyOf:
- description: The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
type: string
x-documentation-priority: default
- type: 'null'
merchant_state:
anyOf:
- description: The state the merchant resides in.
type: string
x-documentation-priority: default
- type: 'null'
network_identifiers:
additionalProperties: false
description: Network-specific identifiers for this refund.
properties:
acquirer_business_id:
description: A network assigned business ID that identifies the acquirer that processed this transaction.
type: string
x-documentation-priority: default
acquirer_reference_number:
description: A globally unique identifier for this settlement.
type: string
x-documentation-priority: default
authorization_identification_response:
anyOf:
- description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.
type: string
x-documentation-priority: default
- type: 'null'
transaction_id:
anyOf:
- description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.
type: string
x-documentation-priority: default
- type: 'null'
required:
- transaction_id
- acquirer_reference_number
- acquirer_business_id
- authorization_identification_response
title: Card Refund NetworkIdentifiers
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: NetworkIdentifiers
presentment_amount:
description: The amount in the minor unit of the transaction's presentment currency.
type: integer
x-documentation-priority: default
presentment_currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
type: string
x-documentation-priority: default
purchase_details:
anyOf:
- additionalProperties: false
description: Additional details about the card purchase, such as tax and industry-specific fields.
example:
car_rental: null
customer_reference_identifier: '51201'
local_tax_amount: null
local_tax_currency: usd
lodging:
check_in_date: '2023-07-20'
daily_room_rate_amount: 1000
daily_room_rate_currency: usd
extra_charges: restaurant
folio_cash_advances_amount: 0
folio_cash_advances_currency: usd
food_beverage_charges_amount: 0
food_beverage_charges_currency: usd
# --- truncated at 32 KB (292 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-transactions-api-openapi.yml