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).
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 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:
card_authorization:
additionalProperties: true
description: Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.
example:
actioner: increase
additional_amounts:
clinic: null
dental: null
original: null
prescription: null
surcharge:
amount: 10
currency: USD
total_cumulative: null
total_healthcare: null
transit: null
unknown: null
vision: null
amount: 100
card_payment_id: card_payment_nd3k2kacrqjli8482ave
currency: USD
digital_wallet_token_id: null
direction: settlement
expires_at: '2020-01-31T23:59:59Z'
id: card_authorization_6iqxap6ivd0fo5eu3i8x
merchant_acceptor_id: '5665270011000168'
merchant_category_code: '5734'
merchant_city: New York
merchant_country: US
merchant_descriptor: AMAZON.COM
merchant_postal_code: '10045'
merchant_state: NY
network_details:
category: visa
pulse: null
visa:
electronic_commerce_indicator: secure_electronic_commerce
point_of_service_entry_mode: manual
stand_in_processing_reason: null
terminal_entry_capability: magnetic_stripe
network_identifiers:
authorization_identification_response: null
retrieval_reference_number: '785867080153'
trace_number: '487941'
transaction_id: '627199945183184'
network_risk_score: 10
pending_transaction_id: null
physical_card_id: null
presentment_amount: 100
presentment_currency: USD
processing_category: purchase
real_time_decision_id: 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'
terminal_id: RCN5VNXS
type: card_authorization
verification:
card_verification_code:
result: match
cardholder_address:
actual_line1: 33 Liberty Street
actual_postal_code: '94131'
provided_line1: 33 Liberty Street
provided_postal_code: '94132'
result: postal_code_no_match_address_match
cardholder_name: null
properties:
actioner:
description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.
enum:
- user
- increase
- network
type: string
x-documentation-priority: default
x-enum-descriptions:
- This object was actioned by the user through a real-time decision.
- This object was actioned by Increase without user intervention.
- This object was actioned by the network, through stand-in processing.
additional_amounts:
additionalProperties: false
description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.
properties:
clinic:
anyOf:
- additionalProperties: false
description: The part of this transaction amount that was for clinic-related services.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
dental:
anyOf:
- additionalProperties: false
description: The part of this transaction amount that was for dental-related services.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
original:
anyOf:
- additionalProperties: false
description: The original pre-authorized amount.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
prescription:
anyOf:
- additionalProperties: false
description: The part of this transaction amount that was for healthcare prescriptions.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
surcharge:
anyOf:
- additionalProperties: false
description: The surcharge amount charged for this transaction by the merchant.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
total_cumulative:
anyOf:
- additionalProperties: false
description: The total amount of a series of incremental authorizations, optionally provided.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
total_healthcare:
anyOf:
- additionalProperties: false
description: The total amount of healthcare-related additional amounts.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
transit:
anyOf:
- additionalProperties: false
description: The part of this transaction amount that was for transit-related services.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
unknown:
anyOf:
- additionalProperties: false
description: An unknown additional amount.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
vision:
anyOf:
- additionalProperties: false
description: The part of this transaction amount that was for vision-related services.
properties:
amount:
description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
type: integer
x-documentation-priority: default
currency:
description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
type: string
x-documentation-priority: default
required:
- amount
- currency
title: Card Authorization AdditionalAmounts AdditionalAmount
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
- type: 'null'
required:
- total_healthcare
- total_cumulative
- surcharge
- transit
- vision
- clinic
- dental
- prescription
- original
- unknown
title: Card Authorization AdditionalAmounts
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: s
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
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
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)
digital_wallet_token_id:
anyOf:
- description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
type: string
x-documentation-priority: default
x-id-reference-to: Digital Wallet Tokens
- type: 'null'
direction:
description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.
enum:
- settlement
- refund
type: string
x-documentation-priority: default
x-enum-descriptions:
- A regular card authorization where funds are debited from the cardholder.
- A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder.
expires_at:
description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization will expire and the pending transaction will be released.
format: date-time
type: string
x-documentation-priority: default
id:
description: The Card Authorization identifier.
type: string
x-documentation-priority: default
x-id-reference-to: Card Authorizations
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 Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
type: string
x-documentation-priority: default
merchant_city:
anyOf:
- description: The city the merchant resides in.
type: string
x-documentation-priority: default
- type: 'null'
merchant_country:
description: The country the merchant resides in.
type: string
x-documentation-priority: default
merchant_descriptor:
description: The merchant descriptor of the merchant the card is transacting with.
type: string
x-documentation-priority: default
merchant_postal_code:
anyOf:
- description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.
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_details:
additionalProperties: false
description: Fields specific to the `network`.
properties:
category:
description: The payment network used to process this card authorization.
enum:
- visa
- pulse
type: string
x-documentation-priority: default
x-enum-descriptions:
- Visa
- Pulse
pulse:
anyOf:
- additionalProperties: false
description: Fields specific to the `pulse` network.
properties: {}
title: Card Authorization NetworkDetails Pulse
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: true
x-title-plural: Pulses
- type: 'null'
visa:
anyOf:
- additionalProperties: false
description: Fields specific to the `visa` network.
properties:
electronic_commerce_indicator:
anyOf:
- description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
enum:
- mail_phone_order
- recurring
- installment
- unknown_mail_phone_order
- secure_electronic_commerce
- non_authenticated_security_transaction_at_3ds_capable_merchant
- non_authenticated_security_transaction
- non_secure_transaction
type: string
x-documentation-priority: default
x-enum-descriptions:
- 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.'
- 'Recurring transaction: Payment indicator used to indicate a recurring transact
# --- 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