The Increase API is organized around REST. It has predictable resource-oriented URLs, accepts and returns JSON-encoded payloads, and uses standard HTTP response codes, authentication, and verbs.
While we're continually adding new features to the API, we're committed to doing so in a way that doesn't break existing integrations. You can read more in our versioning and backwards compatibility guide.
The API accepts Bearer Authentication. When you sign up for an Increase account, we make you a pair of API keys: one for production and one for our sandbox environment in which no real money moves. You can create and revoke API keys from the dashboard and should securely store them using a secret management system.
Production API requests should be to https://api.increase.com
and sandbox requests should be to https://sandbox.increase.com
. We'll put these into environment variables to make our code examples easier to follow.
This reference also exists in OpenAPI 3 format. This spec is in beta and subject to change. If you find it useful, or have feedback, let us know!
If you're interested in building an application that connects to other Increase users' data, you can build an OAuth application. Learn more about this in our OAuth guide.
When making a POST
request to the API, use a Content-Type
of application/json
and specify parameters via JSON in the request body:
When making a GET
request to the API, you should specify parameters in the query string of the URL. Join nested parameters, such as timestamp-based filters, with a .
– for example, created_at.before
:
All responses from the API will have a Content-Type
of application/json
.
List endpoints return a wrapper object with the data and a cursor. The API will return the next page of results if you submit the next_cursor
as a query parameter with the name cursor
. Any filter parameters passed to the original list request must be included if next_cursor
is specified. The maximum (and default) page size is 100 objects. You can adjust it using the limit
parameter.
The API uses standard HTTP response codes to indicate the success or failure of requests. Codes in the 2xx range indicate success; codes in the 4xx and 5xx range indicate errors. Error objects conform to RFC 9457 and can be distinguished by their type
attribute. Errors will always have the same shape.
Additional information about this particular error.
The HTTP status code of the error is also included in the response body for easier debugging.
A human-readable string explaining the type of error.
The type of error that occurred. This is a machine-readable enum.
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create an ACH Transfer does not respond due to a network connection error, you can retry the request with the same idempotency key to guarantee that no more than one transfer is created.
To perform an idempotent request, provide an additional, unique Idempotency-Key
request header per intended request.
POST
endpoints also allow passing idempotency_key
as a JSON parameter.
Read more about Increase's idempotency keys.
When building your application, you can use these APIs to simulate external effects. They can be helpful to quickly test events that might take several hours in the real world (like receiving a wire or ACH). These APIs will only work in the sandbox. If you have a sandbox Event Subscription configured, calling these APIs will also result in the appropriate webhooks being sent to your endpoint.
Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
The bank the Account is with.
The ISO 8601 time at which the Account was closed.
The ISO 8601 time at which the Account was created.
The identifier for the Entity the Account belongs to.
The Account identifier.
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.
The identifier of an Entity that, while not owning the Account, is associated with its activity.
The interest accrued but not yet paid, expressed as a string containing a floating-point value.
The latest ISO 8601 date on which interest was accrued.
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".
The name you choose for the Account.
The identifier of the Program determining the compliance and commercial terms of this Account.
The status of the Account.
A constant representing the object's type. For this resource it will always be account
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Accounts for those belonging to the specified Entity.
Filter Accounts for those belonging to the specified Entity as informational.
Filter Accounts for those in a specific Program.
Filter Accounts for those with the specified status.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
Filter records to the one with the specified idempotency_key
you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
The identifier for the Entity that will own the Account.
The identifier of an Entity that, while not owning the Account, is associated with its activity. Its relationship to your group must be informational
.
The name you choose for the Account.
The identifier for the Program that this Account falls under. Required if you operate more than one Program.
The identifier of the Account to retrieve.
The identifier of the Account to update.
The new name of the Account.
The identifier of the Account to retrieve.
The moment to query the balance at. If not set, returns the current balances.
The identifier of the Account to close. The account must have a zero balance.
Simulates an interest payment to your account. In production, this happens automatically on the first of each month.
The identifier of the Account Number the Interest Payment is for.
The interest amount in cents. Must be positive.
The end of the interest period. If not provided, defaults to the current time.
The start of the interest period. If not provided, defaults to the current time.
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.
The identifier for the account this Account Number belongs to.
The account number.
The ISO 8601 time at which the Account Number was created.
The Account Number identifier.
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.
Properties related to how this Account Number handles inbound ACH transfers.
Properties related to how this Account Number should handle inbound check withdrawals.
The name you choose for the Account Number.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
This indicates if payments can be made to the Account Number.
A constant representing the object's type. For this resource it will always be account_number
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
The status to retrieve Account Numbers for.
The ACH Debit status to retrieve Account Numbers for.
Filter Account Numbers to those belonging to the specified Account.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
Filter records to the one with the specified idempotency_key
you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
The Account the Account Number should belong to.
Options related to how this Account Number should handle inbound ACH transfers.
Options related to how this Account Number should handle inbound check withdrawals.
The name you choose for the Account Number.
The identifier of the Account Number to retrieve.
The identifier of the Account Number.
Options related to how this Account Number handles inbound ACH transfers.
Options related to how this Account Number should handle inbound check withdrawals.
The name you choose for the Account Number.
This indicates if transfers can be made to the Account Number.
Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement.
The identifier for the Account the Transaction belongs to.
The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
The ISO 8601 date on which the Transaction occurred.
The ISO 4217 code for the Transaction's currency. This will match the currency on the Transaction's Account.
An informational message describing this transaction. Use the fields in source
to get more detailed information. This field appears as the line-item on the statement.
The Transaction identifier.
The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
The type of the route this Transaction came through.
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
A constant representing the object's type. For this resource it will always be transaction
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Transactions for those belonging to the specified Account.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
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
.
Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID.
The identifier of the Transaction to retrieve.
Pending Transactions are potential future additions and removals of money from your bank account.
The identifier for the account this Pending Transaction belongs to.
The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
The ISO 8601 date on which the Pending Transaction was completed.
The ISO 8601 date on which the Pending Transaction occurred.
The ISO 4217 code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
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.
The Pending Transaction identifier.
The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.
The type of the route this Pending Transaction came through.
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.
Whether the Pending Transaction has been confirmed and has an associated Transaction.
A constant representing the object's type. For this resource it will always be pending_transaction
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter pending transactions to those belonging to the specified Account.
Filter pending transactions to those belonging to the specified Route.
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
.
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
.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
The identifier of the Pending Transaction.
This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of e.g., an ACH debit.
The inbound funds hold to release.
Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
The identifier for the Account the Declined Transaction belongs to.
The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
The ISO 8601 date on which the Transaction occurred.
The ISO 4217 code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
This is the description the vendor provides.
The Declined Transaction identifier.
The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.
The type of the route this Declined Transaction came through.
This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
A constant representing the object's type. For this resource it will always be declined_transaction
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Declined Transactions to ones belonging to the specified Account.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
Filter Declined Transactions to those belonging to the specified route.
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
.
The identifier of the Declined Transaction.
Account transfers move funds between your own accounts at Increase.
The Account to which the transfer belongs.
The transfer amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
The ISO 8601 date and time at which the transfer was created.
What object created the transfer, either via the API or the dashboard.
The description that will show on the transactions.
The destination account's identifier.
The ID for the transaction receiving the transfer.
The account transfer's identifier.
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.
The transfer's network.
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.
The lifecycle status of the transfer.
The ID for the transaction funding the transfer.
A constant representing the object's type. For this resource it will always be account_transfer
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Account Transfers to those that originated from the specified Account.
Filter records to the one with the specified idempotency_key
you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
The identifier for the account that will send the transfer.
The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.
The description you choose to give the transfer.
The identifier for the account that will receive the transfer.
Whether the transfer requires explicit approval via the dashboard or API.
The identifier of the Account Transfer.
The identifier of the Account Transfer to approve.
The identifier of the pending Account Transfer to cancel.
If your account is configured to require approval for each transfer, this endpoint simulates the approval of an Account Transfer. You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a status
of pending_approval
.
The identifier of the Account Transfer you wish to complete.
ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
The Account to which the transfer belongs.
The destination account number.
After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
Additional information that will be sent to the recipient.
The transfer amount in USD cents. A positive amount indicates a credit transfer pushing funds to the receiving account. A negative amount indicates a debit transfer pulling funds from the receiving account.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
The description of the date of the transfer.
The data you chose to associate with the transfer.
The description of the transfer you set to be shown to the recipient.
The name by which the recipient knows you.
The ISO 8601 date and time at which the transfer was created.
What object created the transfer, either via the API or the dashboard.
The ISO 4217 code for the transfer's currency. For ACH transfers this is always equal to usd
.
The type of entity that owns the account to which the ACH Transfer is being sent.
The identifier of the External Account the transfer was made to, if any.
The type of the account to which the transfer will be sent.
The ACH transfer's identifier.
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.
Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.
Your identifier for the transfer recipient.
The name of the transfer recipient. This value is information and not verified by the recipient's bank.
The transfer's network.
If the receiving bank accepts the transfer but notifies that future transfers should use different details, this will contain those details.
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.
Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule
of same_day
. If set, exactly one of the child attributes must be set.
If your transfer is returned, this will contain details of the return.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
A subhash containing information about when and how the transfer settled at the Federal Reserve.
The Standard Entry Class (SEC) code to use for the transfer.
The descriptor that will show on the recipient's bank statement.
The lifecycle status of the transfer.
After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their posted schedule.
The ID for the transaction funding the transfer.
A constant representing the object's type. For this resource it will always be ach_transfer
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter ACH Transfers to those that originated from the specified Account.
Filter ACH Transfers to those made to the specified External Account.
Filter records to the one with the specified idempotency_key
you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
The Increase identifier for the account that will send the transfer.
The account number for the destination account.
Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank.
The transfer amount in USD cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.
The description of the date of the transfer, usually in the format YYMMDD
. This is included in the transfer data sent to the receiving bank.
The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank.
A description of the transfer. This is included in the transfer data sent to the receiving bank.
The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank.
The type of entity that owns the account to which the ACH Transfer is being sent.
The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number
, routing_number
, and funding
must be absent.
The type of the account to which the transfer will be sent.
Your identifier for the transfer recipient.
The name of the transfer recipient. This value is informational and not verified by the recipient's bank.
Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule
of same_day
. If set, exactly one of the child attributes must be set.
Whether the transfer requires explicit approval via the dashboard or API.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
The Standard Entry Class (SEC) code to use for the transfer.
A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If individual_name
and company_name
are not explicitly set by this API, the statement_descriptor
will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass individual_name
and company_name
instead of relying on this fallback.
The timing of the transaction.
The identifier of the ACH Transfer.
Approves an ACH Transfer in a pending_approval state.
The identifier of the ACH Transfer to approve.
Cancels an ACH Transfer in a pending_approval state.
The identifier of the pending ACH Transfer to cancel.
Simulates the acknowledgement of an ACH Transfer by the Federal Reserve. This transfer must first have a status
of submitted
. In production, the Federal Reserve generally acknowledges submitted ACH files within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and add the acknowledgment subresource to the ACH Transfer.
The identifier of the ACH Transfer you wish to become acknowledged.
Simulates receiving a Notification of Change for an ACH Transfer.
The identifier of the ACH Transfer you wish to create a notification of change for.
The reason for the notification of change.
The corrected data for the notification of change (e.g., a new routing number).
Simulates the return of an ACH Transfer by the Federal Reserve due to an error condition. This will also create a Transaction to account for the returned funds. This transfer must first have a status
of submitted
.
The identifier of the ACH Transfer you wish to return.
The reason why the Federal Reserve or destination bank returned this transfer. Defaults to no_account
.
Simulates the settlement of an ACH Transfer by the Federal Reserve. This transfer must first have a status
of submitted
. Without this simulation the transfer will eventually settle on its own following the same Federal Reserve timeline as in production.
The identifier of the ACH Transfer you wish to become settled.
Simulates the submission of an ACH Transfer to the Federal Reserve. This transfer must first have a status
of pending_approval
or pending_submission
. In production, Increase submits ACH Transfers to the Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and transition the ACH Transfer to a status of submitted
.
The identifier of the ACH Transfer you wish to submit.
ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
The destination account number.
Additional information for the recipient.
The description of the date of the notification.
Optional data associated with the notification.
The description of the notification.
The name by which you know the company.
The ISO 8601 date and time at which the prenotification was created.
If the notification is for a future credit or debit.
The effective date in ISO 8601 format.
The ACH Prenotification's identifier.
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.
If the receiving bank notifies that future transfers should use different details, this will contain those details.
If your prenotification is returned, this will contain details of the return.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
The lifecycle status of the ACH Prenotification.
A constant representing the object's type. For this resource it will always be ach_prenotification
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter records to the one with the specified idempotency_key
you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
The Increase identifier for the account that will send the transfer.
The account number for the destination account.
Additional information that will be sent to the recipient.
The description of the date of the transfer.
The data you choose to associate with the transfer.
The description of the transfer you wish to be shown to the recipient.
The name by which the recipient knows you.
Whether the Prenotification is for a future debit or credit.
The transfer effective date in ISO 8601 format.
Your identifier for the transfer recipient.
The name of the transfer recipient. This value is information and not verified by the recipient's bank.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
The Standard Entry Class (SEC) code to use for the ACH Prenotification.
The identifier of the ACH Prenotification to retrieve.
An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.
If your transfer is accepted, this will contain details of the acceptance.
The Account to which the transfer belongs.
The identifier of the Account Number to which this transfer was sent.
Additional information sent from the originator.
The transfer amount in USD cents.
The time at which the transfer will be automatically resolved.
If your transfer is declined, this will contain details of the decline.
The direction of the transfer.
The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability.
The settlement schedule the transfer is expected to follow.
The inbound ACH transfer's identifier.
If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.
If you initiate a notification of change in response to the transfer, this will contain its details.
The descriptive date of the transfer.
The additional information included with the transfer.
The description of the transfer.
The id of the company that initiated the transfer.
The name of the company that initiated the transfer.
The American Banking Association (ABA) routing number of the bank originating the transfer.
The id of the receiver of the transfer.
The name of the receiver of the transfer.
The Standard Entry Class (SEC) code of the transfer.
The status of the transfer.
The trace number of the transfer.
If your transfer is returned, this will contain details of the return.
A constant representing the object's type. For this resource it will always be inbound_ach_transfer
.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Inbound ACH Tranfers to ones belonging to the specified Account.
Filter Inbound ACH Tranfers to ones belonging to the specified Account Number.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
Filter Inbound ACH Transfers to those with the specified status.
The identifier of the Inbound ACH Transfer to get details for.
The identifier of the Inbound ACH Transfer for which to create a notification of change.
The updated account number to send in the notification of change.
The updated routing number to send in the notification of change.
The identifier of the Inbound ACH Transfer to decline.
The reason why this transfer will be returned. If this parameter is unset, the return codes will be payment_stopped
for debits and credit_entry_refused_by_receiver
for credits.
The identifier of the Inbound ACH Transfer to return to the originating financial institution.
The reason why this transfer will be returned. The most usual return codes are payment_stopped
for debits and credit_entry_refused_by_receiver
for credits.
Simulates an inbound ACH transfer to your account. This imitates initiating a transfer to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the amount
is positive or negative. The result of calling this API will contain the created transfer. You can pass a resolve_at
parameter to allow for a window to action on the Inbound ACH Transfer. Alternatively, if you don't pass the resolve_at
parameter the result will contain either a Transaction or a Declined Transaction depending on whether or not the transfer is allowed.
The identifier of the Account Number the inbound ACH Transfer is for.
The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.
The description of the date of the transfer.
Data associated with the transfer set by the sender.
The description of the transfer set by the sender.
The sender's company ID.
The name of the sender.
The ID of the receiver of the transfer.
The name of the receiver of the transfer.
The time at which the transfer should be resolved. If not provided will resolve immediately.
The standard entry class code for the transfer.
Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
The Account to which the transfer belongs.
The destination account number.
The transfer amount in USD cents.
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
The beneficiary's address line 1.
The beneficiary's address line 2.
The beneficiary's address line 3.
The beneficiary's name.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
The ISO 8601 date and time at which the transfer was created.
What object created the transfer, either via the API or the dashboard.
The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd
.
The identifier of the External Account the transfer was made to, if any.
The wire transfer's identifier.
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.
The message that will show on the recipient's bank statement.
The transfer's network.
The originator's address line 1.
The originator's address line 2.
The originator's address line 3.
The originator's name.
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.
If your transfer is reversed, this will contain details of the reversal.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
The Account Number that was passed to the wire's recipient.
The lifecycle status of the transfer.
After the transfer is submitted to Fedwire, this will contain supplemental details.
The ID for the transaction funding the transfer.
A constant representing the object's type. For this resource it will always be wire_transfer
.
Simulates the reversal of a Wire Transfer by the Federal Reserve due to error conditions. This will also create a Transaction to account for the returned funds. This Wire Transfer must first have a status
of complete
.
The identifier of the Wire Transfer you wish to reverse.
Simulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status
of pending_approval
or pending_creating
.
The identifier of the Wire Transfer you wish to submit.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Wire Transfers to those belonging to the specified Account.
Filter Wire Transfers to those made to the specified External Account.
Filter records to the one with the specified idempotency_key
you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
The identifier for the account that will send the transfer.
The account number for the destination account.
The transfer amount in USD cents.
The beneficiary's address line 1.
The beneficiary's address line 2.
The beneficiary's address line 3.
The beneficiary's name.
The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number
and routing_number
must be absent.
The message that will show on the recipient's bank statement.
The originator's address line 1. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.
The originator's address line 2. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.
The originator's address line 3. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.
The originator's name. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.
Whether the transfer requires explicit approval via the dashboard or API.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
The ID of an Account Number that will be passed to the wire's recipient
The identifier of the Wire Transfer.
The identifier of the Wire Transfer to approve.
The identifier of the pending Wire Transfer to cancel.
An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.
The Account to which the transfer belongs.
The identifier of the Account Number to which this transfer was sent.
The amount in USD cents.
A free-form address field set by the sender.
A free-form address field set by the sender.
A free-form address field set by the sender.
A name set by the sender.
A free-form reference string set by the sender, to help identify the transfer.
An Increase-constructed description of the transfer.
The inbound wire transfer's identifier.
A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.
The address of the wire originator, set by the sending bank.
The address of the wire originator, set by the sending bank.
The address of the wire originator, set by the sending bank.
The originator of the wire, set by the sending bank.
The American Banking Association (ABA) routing number of the bank originating the transfer.
An Increase-created concatenation of the Originator-to-Beneficiary lines.
A free-form message set by the wire originator.
A free-form message set by the wire originator.
A free-form message set by the wire originator.