Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/increase-pending-transactions-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.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 Pending Transactions API
version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).
name: Pending Transactions
paths:
/pending_transactions:
get:
operationId: list_pending_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 pending transactions to those belonging to the specified Account.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
- in: query
name: route_id
required: false
schema:
description: Filter pending transactions to those belonging to the specified Route.
type: string
x-documentation-priority: default
- 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_instruction
- ach_transfer_instruction
- card_authorization
- check_deposit_instruction
- check_transfer_instruction
- fednow_transfer_instruction
- inbound_funds_hold
- user_initiated_hold
- real_time_payments_transfer_instruction
- wire_transfer_instruction
- inbound_wire_transfer_reversal
- swift_transfer_instruction
- card_push_transfer_instruction
- blockchain_onramp_transfer_instruction
- blockchain_offramp_transfer_instruction
- other
type: string
x-enum-descriptions:
- 'Account Transfer Instruction: details will be under the `account_transfer_instruction` object.'
- 'ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.'
- 'Card Authorization: details will be under the `card_authorization` object.'
- 'Check Deposit Instruction: details will be under the `check_deposit_instruction` object.'
- 'Check Transfer Instruction: details will be under the `check_transfer_instruction` object.'
- 'FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.'
- 'Inbound Funds Hold: details will be under the `inbound_funds_hold` object.'
- 'User Initiated Hold: details will be under the `user_initiated_hold` object.'
- 'Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.'
- 'Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.'
- 'Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.'
- 'Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.'
- 'Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.'
- 'Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.'
- 'Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.'
- The Pending Transaction was made for an undocumented or deprecated reason.
type: array
x-documentation-priority: default
explode: false
- in: query
name: status.in
required: false
schema:
description: Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status `pending` will be returned. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
items:
enum:
- pending
- complete
type: string
x-enum-descriptions:
- The Pending Transaction is still awaiting confirmation.
- The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
type: array
x-documentation-priority: default
explode: false
- 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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pending_transaction_list'
description: Pending Transaction List
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: List Pending Transactions
x-sandbox-only: false
x-tag: Pending Transactions
tags:
- Pending Transactions
post:
description: Creates a pending transaction on an account. This can be useful to hold funds for an external payment or known future transaction outside of Increase (only negative amounts are supported). The resulting Pending Transaction will have a `category` of `user_initiated_hold` and can be released via the API to unlock the held funds.
operationId: create_a_pending_transaction
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_a_pending_transaction_parameters'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pending_transaction'
description: Pending Transaction
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Create a Pending Transaction
x-sandbox-only: false
x-tag: Pending Transactions
tags:
- Pending Transactions
/pending_transactions/{pending_transaction_id}:
get:
operationId: retrieve_a_pending_transaction
parameters:
- example: pending_transaction_k1sfetcau2qbvjbzgju4
in: path
name: pending_transaction_id
required: true
schema:
description: The identifier of the Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Pending Transactions
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pending_transaction'
description: Pending Transaction
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Retrieve a Pending Transaction
x-sandbox-only: false
x-tag: Pending Transactions
tags:
- Pending Transactions
/pending_transactions/{pending_transaction_id}/release:
post:
description: Release a Pending Transaction you had previously created. The Pending Transaction must have a `category` of `user_initiated_hold` and a `status` of `pending`. This will unlock the held funds and mark the Pending Transaction as complete.
operationId: release_a_user_initiated_pending_transaction
parameters:
- example: pending_transaction_k1sfetcau2qbvjbzgju4
in: path
name: pending_transaction_id
required: true
schema:
description: The identifier of the Pending Transaction to release.
type: string
x-documentation-priority: default
x-id-reference-to: Pending Transactions
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pending_transaction'
description: Pending Transaction
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Release a user-initiated Pending Transaction
x-sandbox-only: false
x-tag: Pending Transactions
tags:
- Pending Transactions
components:
schemas:
pending_transaction:
additionalProperties: true
description: Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers).
example:
account_id: account_in71c4amph0vgo2qllky
amount: 100
completed_at: null
created_at: '2020-01-31T23:59:59Z'
currency: USD
description: INVOICE 2468
held_amount: 100
id: pending_transaction_k1sfetcau2qbvjbzgju4
route_id: card_oubs0hwk5rn6knuecxg2
route_type: card
source:
ach_transfer_instruction:
amount: 100
transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
category: ach_transfer_instruction
status: pending
type: pending_transaction
properties:
account_id:
description: The identifier for the account this Pending Transaction belongs to.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
amount:
description: The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
type: integer
x-documentation-priority: default
completed_at:
anyOf:
- description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction was completed.
format: date-time
type: string
x-documentation-priority: default
- type: 'null'
created_at:
description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction occurred.
format: date-time
type: string
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
description:
description: For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.
type: string
x-documentation-priority: default
held_amount:
description: The amount that this Pending Transaction decrements the available balance of its Account. This is usually the same as `amount`, but will differ if the amount is positive.
type: integer
x-documentation-priority: default
id:
description: The Pending Transaction identifier.
type: string
x-documentation-priority: default
x-id-reference-to: Pending Transactions
route_id:
anyOf:
- description: The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.
type: string
x-documentation-priority: default
- type: 'null'
route_type:
anyOf:
- description: The type of the route this Pending Transaction came through.
enum:
- account_number
- card
- lockbox
type: string
x-documentation-priority: default
x-enum-descriptions:
- An Account Number.
- A Card.
- A Lockbox.
- type: 'null'
source:
additionalProperties: true
description: This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
example:
ach_transfer_instruction:
amount: 100
transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
category: ach_transfer_instruction
properties:
account_transfer_instruction:
anyOf:
- additionalProperties: true
description: An Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.
example:
amount: 100
currency: USD
transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
properties:
amount:
description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
transfer_id:
description: The identifier of the Account Transfer that led to this Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Account Transfers
required:
- amount
- currency
- transfer_id
title: Pending Transaction Pending Transaction Source Account Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Account Transfer Instructions
- type: 'null'
ach_transfer_instruction:
anyOf:
- additionalProperties: true
description: An ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.
example:
amount: 100
transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
properties:
amount:
description: The pending amount in USD cents.
type: integer
x-documentation-priority: default
transfer_id:
description: The identifier of the ACH Transfer that led to this Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: ACH Transfers
required:
- amount
- transfer_id
title: Pending Transaction Pending Transaction Source ACH Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: ACH Transfer Instructions
- type: 'null'
blockchain_offramp_transfer_instruction:
anyOf:
- additionalProperties: true
description: A Blockchain Off-Ramp Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_offramp_transfer_instruction`.
example:
source_blockchain_address_id: blockchain_address_tijjpqp9t5d358ehydqi
transfer_id: blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m
properties:
source_blockchain_address_id:
description: The identifier of the Blockchain Address the funds were received at.
type: string
x-documentation-priority: default
x-id-reference-to: Blockchain Addresses
transfer_id:
description: The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Blockchain Off-Ramp Transfers
required:
- transfer_id
- source_blockchain_address_id
title: Pending Transaction Pending Transaction Source Blockchain Off-Ramp Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Blockchain Off-Ramp Transfer Instructions
- type: 'null'
blockchain_onramp_transfer_instruction:
anyOf:
- additionalProperties: false
description: A Blockchain On-Ramp Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_onramp_transfer_instruction`.
example:
amount: 10000
destination_blockchain_address: '0x304a554a310C7e546dfe434669C62820b7D83490'
transfer_id: blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv
properties:
amount:
description: The transfer amount in USD cents.
type: integer
x-documentation-priority: default
destination_blockchain_address:
description: The blockchain address the funds are being sent to.
type: string
x-documentation-priority: default
transfer_id:
description: The identifier of the Blockchain On-Ramp Transfer that led to this Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Blockchain On-Ramp Transfers
required:
- amount
- transfer_id
- destination_blockchain_address
title: Pending Transaction Pending Transaction Source Blockchain On-Ramp Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Blockchain On-Ramp Transfer Instructions
- type: 'null'
card_authorization:
anyOf:
- $ref: '#/components/schemas/card_authorization'
description: A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`. Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.
x-documentation-priority: default
- type: 'null'
card_push_transfer_instruction:
anyOf:
- additionalProperties: false
description: A Card Push Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `card_push_transfer_instruction`.
example:
amount: 100
transfer_id: outbound_card_push_transfer_e0z9rdpamraczh4tvwye
properties:
amount:
description: The transfer amount in USD cents.
type: integer
x-documentation-priority: default
transfer_id:
description: The identifier of the Card Push Transfer that led to this Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Card Push Transfers
required:
- amount
- transfer_id
title: Pending Transaction Pending Transaction Source Card Push Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Card Push Transfer Instructions
- type: 'null'
category:
description: The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
enum:
- account_transfer_instruction
- ach_transfer_instruction
- card_authorization
- check_deposit_instruction
- check_transfer_instruction
- fednow_transfer_instruction
- inbound_funds_hold
- user_initiated_hold
- real_time_payments_transfer_instruction
- wire_transfer_instruction
- inbound_wire_transfer_reversal
- swift_transfer_instruction
- card_push_transfer_instruction
- blockchain_onramp_transfer_instruction
- blockchain_offramp_transfer_instruction
- other
type: string
x-documentation-priority: default
x-enum-descriptions:
- 'Account Transfer Instruction: details will be under the `account_transfer_instruction` object.'
- 'ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.'
- 'Card Authorization: details will be under the `card_authorization` object.'
- 'Check Deposit Instruction: details will be under the `check_deposit_instruction` object.'
- 'Check Transfer Instruction: details will be under the `check_transfer_instruction` object.'
- 'FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.'
- 'Inbound Funds Hold: details will be under the `inbound_funds_hold` object.'
- 'User Initiated Hold: details will be under the `user_initiated_hold` object.'
- 'Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.'
- 'Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.'
- 'Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.'
- 'Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.'
- 'Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.'
- 'Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.'
- 'Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.'
- The Pending Transaction was made for an undocumented or deprecated reason.
check_deposit_instruction:
anyOf:
- additionalProperties: true
description: A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.
example:
amount: 100
back_image_file_id: file_26khfk98mzfz90a11oqx
check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
currency: USD
front_image_file_id: file_makxrc67oh9l6sg7w9yc
properties:
amount:
description: The pending amount in USD cents.
type: integer
x-documentation-priority: default
back_image_file_id:
anyOf:
- description: The identifier of the File containing the image of the back of the check that was deposited.
type: string
x-documentation-priority: default
x-id-reference-to: Files
- type: 'null'
check_deposit_id:
anyOf:
- description: The identifier of the Check Deposit.
type: string
x-documentation-priority: default
x-id-reference-to: Check Deposits
- type: 'null'
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
front_image_file_id:
description: The identifier of the File containing the image of the front of the check that was deposited.
type: string
x-documentation-priority: default
x-id-reference-to: Files
required:
- amount
- currency
- front_image_file_id
- back_image_file_id
- check_deposit_id
title: Pending Transaction Pending Transaction Source Check Deposit Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Check Deposit Instructions
- type: 'null'
check_transfer_instruction:
anyOf:
- additionalProperties: true
description: A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.
example:
amount: 100
currency: USD
transfer_id: check_transfer_30b43acfu9vw8fyc4f5
properties:
amount:
description: The transfer amount in USD cents.
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
enum:
- USD
type: string
x-documentation-priority: default
x-enum-descriptions:
- US Dollar (USD)
transfer_id:
description: The identifier of the Check Transfer that led to this Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: Check Transfers
required:
- amount
- currency
- transfer_id
title: Pending Transaction Pending Transaction Source Check Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Check Transfer Instructions
- type: 'null'
fednow_transfer_instruction:
anyOf:
- additionalProperties: true
description: A FedNow Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `fednow_transfer_instruction`.
example:
transfer_id: fednow_transfer_4i0mptrdu1mueg1196bg
properties:
transfer_id:
description: The identifier of the FedNow Transfer that led to this Pending Transaction.
type: string
x-documentation-priority: default
x-id-reference-to: FedNow Transfers
required:
- transfer_id
title: Pending Transaction Pending Transaction Source FedNow Transfer Instruction
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: FedNow Transfer Instructions
- type: 'null'
inbound_funds_hold:
anyOf:
- $ref: '#/components/schemas/inbound_funds_hold'
description: An Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`. We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.
x-documentation-priority: default
- type: 'null'
inbound_wire_transfer_reversal:
anyOf:
- $ref: '#/components/schemas/inbound_wire_transfer_reversal'
description: An Inbound Wire Transfer Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal is created when Increase has received a wire and the User reque
# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-pending-transactions-api-openapi.yml