Increase Wire Transfers API
Originate Fedwire transfers and process inbound wires and reversals.
OpenAPI Specification
{
"components": {
"responses": {
"errorResponse": {
"content": {
"application/json": { "schema": { "allOf": [{ "$ref": "#/components/schemas/error" }] } }
},
"description": "Error"
}
},
"schemas": {
"account": {
"additionalProperties": true,
"description": "Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.",
"example": {
"account_revenue_rate": null,
"bank": "first_internet_bank",
"closed_at": null,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"funding": "deposits",
"id": "account_in71c4amph0vgo2qllky",
"idempotency_key": null,
"informational_entity_id": null,
"interest_rate": "0.055",
"loan": null,
"name": "My first account!",
"program_id": "program_i2v2os4mwza1oetokh9i",
"status": "open",
"type": "account"
},
"properties": {
"account_revenue_rate": {
"anyOf": [
{
"description": "The account revenue rate currently being earned on the account, as a string containing a decimal number. For example, a 1% account revenue rate would be represented as \"0.01\". Account revenue is a type of non-interest income accrued on the account.",
"pattern": "^-?\\d+(\\.\\d+)?$",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
},
"bank": {
"description": "The bank the Account is with.",
"enum": ["core_bank", "first_internet_bank", "grasshopper_bank"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": ["Core Bank", "First Internet Bank of Indiana", "Grasshopper Bank"]
},
"closed_at": {
"anyOf": [
{
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was closed.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
},
"created_at": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was created.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"currency": {
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency.",
"enum": ["USD"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": ["US Dollar (USD)"]
},
"entity_id": {
"description": "The identifier for the Entity the Account belongs to.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Entities"
},
"funding": {
"description": "Whether the Account is funded by a loan or by deposits.",
"enum": ["loan", "deposits"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": [
"An account funded by a loan. Before opening a loan account, contact [email protected] to set up a loan program.",
"An account funded by deposits."
]
},
"id": {
"description": "The Account identifier.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Accounts"
},
"idempotency_key": {
"anyOf": [
{
"description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
},
"informational_entity_id": {
"anyOf": [
{
"description": "The identifier of an Entity that, while not owning the Account, is associated with its activity.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Entities"
},
{ "type": "null" }
]
},
"interest_rate": {
"description": "The interest rate currently being earned on the account, as a string containing a decimal number. For example, a 1% interest rate would be represented as \"0.01\".",
"pattern": "^-?\\d+(\\.\\d+)?$",
"type": "string",
"x-documentation-priority": "default"
},
"loan": {
"anyOf": [
{
"additionalProperties": false,
"description": "The Account's loan-related information, if the Account is a loan account.",
"properties": {
"credit_limit": {
"description": "The maximum amount of money that can be borrowed on the Account.",
"type": "integer",
"x-documentation-priority": "default"
},
"grace_period_days": {
"description": "The number of days after the statement date that the Account can be past due before being considered delinquent.",
"type": "integer",
"x-documentation-priority": "default"
},
"maturity_date": {
"anyOf": [
{
"description": "The date on which the loan matures.",
"format": "date",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
},
"statement_day_of_month": {
"description": "The day of the month on which the loan statement is generated.",
"type": "integer",
"x-documentation-priority": "default"
},
"statement_payment_type": {
"description": "The type of payment for the loan.",
"enum": ["balance", "interest_until_maturity"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": [
"The borrower must pay the full balance of the loan at the end of the statement period.",
"The borrower must pay the accrued interest at the end of the statement period."
]
}
},
"required": [
"credit_limit",
"grace_period_days",
"maturity_date",
"statement_payment_type",
"statement_day_of_month"
],
"title": "Account Loan",
"type": "object",
"x-documentation-priority": "default",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Loans"
},
{ "type": "null" }
]
},
"name": {
"description": "The name you choose for the Account.",
"type": "string",
"x-documentation-priority": "default"
},
"program_id": {
"description": "The identifier of the Program determining the compliance and commercial terms of this Account.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Programs"
},
"status": {
"description": "The status of the Account.",
"enum": ["closed", "open"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": [
"Closed Accounts on which no new activity can occur.",
"Open Accounts that are ready to use."
]
},
"type": {
"description": "A constant representing the object's type. For this resource it will always be `account`.",
"enum": ["account"],
"type": "string",
"x-documentation-priority": "default"
}
},
"required": [
"type",
"bank",
"created_at",
"loan",
"closed_at",
"currency",
"entity_id",
"funding",
"informational_entity_id",
"id",
"program_id",
"interest_rate",
"account_revenue_rate",
"name",
"status",
"idempotency_key"
],
"title": "Account",
"type": "object",
"x-event-categories": ["account.created", "account.updated"],
"x-stainless-empty-object": false,
"x-tag": "Accounts",
"x-title-plural": "Accounts"
},
"account_list": {
"additionalProperties": true,
"description": "A list of Account objects.",
"example": {
"data": [
{
"account_revenue_rate": null,
"bank": "first_internet_bank",
"closed_at": null,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"funding": "deposits",
"id": "account_in71c4amph0vgo2qllky",
"idempotency_key": null,
"informational_entity_id": null,
"interest_rate": "0.055",
"loan": null,
"name": "My first account!",
"program_id": "program_i2v2os4mwza1oetokh9i",
"status": "open",
"type": "account"
}
],
"next_cursor": "v57w5d"
},
"properties": {
"data": {
"description": "The contents of the list.",
"items": { "$ref": "#/components/schemas/account" },
"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": "Account List",
"type": "object",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Account Lists"
},
"account_number": {
"additionalProperties": true,
"description": "Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.",
"example": {
"account_id": "account_in71c4amph0vgo2qllky",
"account_number": "987654321",
"created_at": "2020-01-31T23:59:59Z",
"id": "account_number_v18nkfqm6afpsrvy82b2",
"idempotency_key": null,
"inbound_ach": { "debit_status": "blocked" },
"inbound_checks": { "status": "check_transfers_only" },
"name": "ACH",
"routing_number": "101050001",
"status": "active",
"type": "account_number"
},
"properties": {
"account_id": {
"description": "The identifier for the account this Account Number belongs to.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Accounts"
},
"account_number": {
"description": "The account number.",
"type": "string",
"x-documentation-priority": "default"
},
"created_at": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Number was created.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"id": {
"description": "The Account Number identifier.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Account Numbers"
},
"idempotency_key": {
"anyOf": [
{
"description": "The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
},
"inbound_ach": {
"additionalProperties": false,
"description": "Properties related to how this Account Number handles inbound ACH transfers.",
"properties": {
"debit_status": {
"description": "Whether ACH debits are allowed against this Account Number. Note that they will still be declined if this is `allowed` if the Account Number is not active.",
"enum": ["allowed", "blocked"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": ["ACH Debits are allowed.", "ACH Debits are blocked."]
}
},
"required": ["debit_status"],
"title": "Account Number InboundACH",
"type": "object",
"x-documentation-priority": "default",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "InboundAchs"
},
"inbound_checks": {
"additionalProperties": false,
"description": "Properties related to how this Account Number should handle inbound check withdrawals.",
"properties": {
"status": {
"description": "How Increase should process checks with this account number printed on them.",
"enum": ["allowed", "check_transfers_only"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": [
"Checks with this Account Number will be processed even if they are not associated with a Check Transfer.",
"Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer."
]
}
},
"required": ["status"],
"title": "Account Number InboundChecks",
"type": "object",
"x-documentation-priority": "default",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "InboundChecks"
},
"name": {
"description": "The name you choose for the Account Number.",
"type": "string",
"x-documentation-priority": "default"
},
"routing_number": {
"description": "The American Bankers' Association (ABA) Routing Transit Number (RTN).",
"type": "string",
"x-documentation-priority": "default"
},
"status": {
"description": "This indicates if payments can be made to the Account Number.",
"enum": ["active", "disabled", "canceled"],
"type": "string",
"x-documentation-priority": "default",
"x-enum-descriptions": [
"The account number is active.",
"The account number is temporarily disabled.",
"The account number is permanently disabled."
]
},
"type": {
"description": "A constant representing the object's type. For this resource it will always be `account_number`.",
"enum": ["account_number"],
"type": "string",
"x-documentation-priority": "default"
}
},
"required": [
"type",
"account_id",
"account_number",
"id",
"created_at",
"name",
"routing_number",
"status",
"inbound_ach",
"inbound_checks",
"idempotency_key"
],
"title": "Account Number",
"type": "object",
"x-event-categories": ["account_number.created", "account_number.updated"],
"x-stainless-empty-object": false,
"x-tag": "Account Numbers",
"x-title-plural": "Account Numbers"
},
"account_number_list": {
"additionalProperties": true,
"description": "A list of Account Number objects.",
"example": {
"data": [
{
"account_id": "account_in71c4amph0vgo2qllky",
"account_number": "987654321",
"created_at": "2020-01-31T23:59:59Z",
"id": "account_number_v18nkfqm6afpsrvy82b2",
"idempotency_key": null,
"inbound_ach": { "debit_status": "blocked" },
"inbound_checks": { "status": "check_transfers_only" },
"name": "ACH",
"routing_number": "101050001",
"status": "active",
"type": "account_number"
}
],
"next_cursor": "v57w5d"
},
"properties": {
"data": {
"description": "The contents of the list.",
"items": { "$ref": "#/components/schemas/account_number" },
"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": "Account Number List",
"type": "object",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Account Number Lists"
},
"account_statement": {
"additionalProperties": false,
"description": "Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.",
"example": {
"account_id": "account_in71c4amph0vgo2qllky",
"created_at": "2020-01-31T23:59:59Z",
"ending_balance": 100,
"file_id": "file_makxrc67oh9l6sg7w9yc",
"id": "account_statement_lkc03a4skm2k7f38vj15",
"loan": null,
"starting_balance": 0,
"statement_period_end": "2020-01-31T23:59:59Z",
"statement_period_start": "2020-01-31T23:59:59Z",
"type": "account_statement"
},
"properties": {
"account_id": {
"description": "The identifier for the Account this Account Statement belongs to.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Accounts"
},
"created_at": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"ending_balance": {
"description": "The Account's balance at the end of its statement period.",
"type": "integer",
"x-documentation-priority": "default"
},
"file_id": {
"description": "The identifier of the File containing a PDF of the statement.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Files"
},
"id": {
"description": "The Account Statement identifier.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Account Statements"
},
"loan": {
"anyOf": [
{
"additionalProperties": false,
"description": "The loan balances.",
"properties": {
"due_at": {
"anyOf": [
{
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan payment is due.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
},
"due_balance": {
"description": "The total amount due on the loan.",
"type": "integer",
"x-documentation-priority": "default"
},
"past_due_balance": {
"description": "The amount past due on the loan.",
"type": "integer",
"x-documentation-priority": "default"
}
},
"required": ["due_balance", "past_due_balance", "due_at"],
"title": "Account Statement Loan",
"type": "object",
"x-documentation-priority": "default",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Loans"
},
{ "type": "null" }
]
},
"starting_balance": {
"description": "The Account's balance at the start of its statement period.",
"type": "integer",
"x-documentation-priority": "default"
},
"statement_period_end": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"statement_period_start": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"type": {
"description": "A constant representing the object's type. For this resource it will always be `account_statement`.",
"enum": ["account_statement"],
"type": "string",
"x-documentation-priority": "default"
}
},
"required": [
"type",
"id",
"account_id",
"created_at",
"file_id",
"statement_period_start",
"statement_period_end",
"starting_balance",
"ending_balance",
"loan"
],
"title": "Account Statement",
"type": "object",
"x-event-categories": ["account_statement.created"],
"x-stainless-empty-object": false,
"x-tag": "Account Statements",
"x-title-plural": "Account Statements"
},
"account_statement_list": {
"additionalProperties": true,
"description": "A list of Account Statement objects.",
"example": {
"data": [
{
"account_id": "account_in71c4amph0vgo2qllky",
"created_at": "2020-01-31T23:59:59Z",
"ending_balance": 100,
"file_id": "file_makxrc67oh9l6sg7w9yc",
"id": "account_statement_lkc03a4skm2k7f38vj15",
"loan": null,
"starting_balance": 0,
"statement_period_end": "2020-01-31T23:59:59Z",
"statement_period_start": "2020-01-31T23:59:59Z",
"type": "account_statement"
}
],
"next_cursor": "v57w5d"
},
"properties": {
"data": {
"description": "The contents of the list.",
"items": { "$ref": "#/components/schemas/account_statement" },
"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": "Account Statement List",
"type": "object",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Account Statement Lists"
},
"account_transfer": {
"additionalProperties": true,
"description": "Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).",
"example": {
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null },
"cancellation": null,
"created_at": "2020-01-31T23:59:59Z",
"created_by": { "category": "user", "user": { "email": "[email protected]" } },
"currency": "USD",
"description": "Move money into savings",
"destination_account_id": "account_uf16sut2ct5bevmq3eh",
"destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4",
"id": "account_transfer_7k9qe1ysdgqztnt63l7n",
"idempotency_key": null,
"pending_transaction_id": null,
"status": "complete",
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"type": "account_transfer"
},
"properties": {
"account_id": {
"description": "The Account from which the transfer originated.",
"type": "string",
"x-documentation-priority": "default",
"x-id-reference-to": "Accounts"
},
"amount": {
"description": "The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.",
"type": "integer",
"x-documentation-priority": "default"
},
"approval": {
"anyOf": [
{
"additionalProperties": false,
"description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.",
"example": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null },
"properties": {
"approved_at": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"approved_by": {
"anyOf": [
{
"description": "If the Transfer was approved by a user in the dashboard, the email address of that user.",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
}
},
"required": ["approved_at", "approved_by"],
"title": "Account Transfer Transfer Approval",
"type": "object",
"x-documentation-priority": "default",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Transfer Approvals"
},
{ "type": "null" }
]
},
"cancellation": {
"anyOf": [
{
"additionalProperties": false,
"description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.",
"example": { "canceled_at": "2020-01-31T23:59:59Z", "canceled_by": null },
"properties": {
"canceled_at": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"canceled_by": {
"anyOf": [
{
"description": "If the Transfer was canceled by a user in the dashboard, the email address of that user.",
"type": "string",
"x-documentation-priority": "default"
},
{ "type": "null" }
]
}
},
"required": ["canceled_at", "canceled_by"],
"title": "Account Transfer Transfer Cancellation",
"type": "object",
"x-documentation-priority": "default",
"x-event-categories": [],
"x-stainless-empty-object": false,
"x-title-plural": "Transfer Cancellations"
},
{ "type": "null" }
]
},
"created_at": {
"description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.",
"format": "date-time",
"type": "string",
"x-documentation-priority": "default"
},
"created_by": {
"anyOf": [
{
"additionalProperties": false,
"description": "What object created the transfer, either via the API or the dashboard.",
"example": { "category": "user", "user": { "email": "[email protected]" } },
"properties": {
"api_key": {
"anyOf": [
{
"additionalProperties": false,
"description": "If present, details about the API key that created the transfer.",
# --- truncated at 32 KB (3448 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-openapi.json