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. 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.
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.
Retrieve the current and available balances for an account in minor units of the account's currency. Learn more about account balances.
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 the Interest Payment should be paid to is for.
The identifier of the Account the Interest accrued on. Defaults to account_id.
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. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
The ACH Debit status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 company ID associated with the transfer.
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 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.
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 pending_submission or submitted. For convenience, if the transfer is in status: pending_submission, the simulation will also submit the transfer. 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.
The ISO 8601 date and time at which the inbound ACH transfer was created.
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.
A 15 digit number set by the sending bank and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer. ACH trace numbers are not unique, but are used to correlate returns.
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 Transfers to ones belonging to the specified Account.
Filter Inbound ACH Transfers 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. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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.
Additional information to include in the transfer.
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.
The ISO 8601 date and time at which the inbound wire transfer was created.
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.
A free-form message set by the wire originator.
Information about the reversal of the inbound wire transfer if it has been reversed.
The sending bank's reference number for the wire transfer.
The status of the transfer.
A constant representing the object's type. For this resource it will always be inbound_wire_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 Wire Transfers to ones belonging to the specified Account.
Filter Inbound Wire Transfers 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 Wire Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
The identifier of the Inbound Wire Transfer to get details for.
The identifier of the Inbound Wire Transfer to reverse.
Reason for the reversal.
Simulates an Inbound Wire Transfer to your account.
The identifier of the Account Number the inbound Wire Transfer is for.
The transfer amount in cents. Must be positive.
The sending bank will set beneficiary_address_line1 in production. You can simulate any value here.
The sending bank will set beneficiary_address_line2 in production. You can simulate any value here.
The sending bank will set beneficiary_address_line3 in production. You can simulate any value here.
The sending bank will set beneficiary_name in production. You can simulate any value here.
The sending bank will set beneficiary_reference in production. You can simulate any value here.
The sending bank will set originator_address_line1 in production. You can simulate any value here.
The sending bank will set originator_address_line2 in production. You can simulate any value here.
The sending bank will set originator_address_line3 in production. You can simulate any value here.
The sending bank will set originator_name in production. You can simulate any value here.
The sending bank will set originator_routing_number in production. You can simulate any value here.
The sending bank will set originator_to_beneficiary_information_line1 in production. You can simulate any value here.
The sending bank will set originator_to_beneficiary_information_line2 in production. You can simulate any value here.
The sending bank will set originator_to_beneficiary_information_line3 in production. You can simulate any value here.
The sending bank will set originator_to_beneficiary_information_line4 in production. You can simulate any value here.
The sending bank will set sender_reference in production. You can simulate any value here.
Wire drawdown requests enable you to request that someone else send you a wire. This feature is in beta; reach out to support@increase.com to learn more.
The Account Number to which the recipient of this request is being requested to send funds.
The amount being requested in cents.
The ISO 8601 date and time at which the wire drawdown request was created.
The ISO 4217 code for the amount being requested. Will always be "USD".
If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.
The Wire drawdown request 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 the recipient will see as part of the drawdown request.
The originator's address line 1.
The originator's address line 2.
The originator's address line 3.
The originator's name.
The drawdown request's recipient's account number.
Line 1 of the drawdown request's recipient's address.
Line 2 of the drawdown request's recipient's address.
Line 3 of the drawdown request's recipient's address.
The drawdown request's recipient's name.
The drawdown request's recipient's routing number.
The lifecycle status of the drawdown request.
After the drawdown request is submitted to Fedwire, this will contain supplemental details.
A constant representing the object's type. For this resource it will always be wire_drawdown_request.
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 Drawdown Requests for those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 Number to which the recipient should send funds.
The amount requested from the recipient, in USD cents.
A message the recipient will see as part of the request.
The drawdown request originator's address line 1. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.
The drawdown request originator's address line 2. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.
The drawdown request originator's address line 3. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.
The drawdown request originator's name. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.
The drawdown request's recipient's account number.
Line 1 of the drawdown request's recipient's address.
Line 2 of the drawdown request's recipient's address.
Line 3 of the drawdown request's recipient's address.
The drawdown request's recipient's name.
The drawdown request's recipient's routing number.
The identifier of the Wire Drawdown Request to retrieve.
Inbound wire drawdown requests are requests from someone else to send them a wire. This feature is in beta; reach out to support@increase.com to learn more.
The amount being requested in cents.
The drawdown request's beneficiary's account number.
Line 1 of the drawdown request's beneficiary's address.
Line 2 of the drawdown request's beneficiary's address.
Line 3 of the drawdown request's beneficiary's address.
The drawdown request's beneficiary's name.
The drawdown request's beneficiary's routing number.
The ISO 8601 date and time at which the inbound wire drawdown requested was created.
The ISO 4217 code for the amount being requested. Will always be "USD".
The Wire drawdown request identifier.
A message from the drawdown request's originator.
The drawdown request's originator's account number.
Line 1 of the drawdown request's originator's address.
Line 2 of the drawdown request's originator's address.
Line 3 of the drawdown request's originator's address.
The drawdown request's originator's name.
The drawdown request's originator's routing number.
Line 1 of the information conveyed from the originator of the message to the beneficiary.
Line 2 of the information conveyed from the originator of the message to the beneficiary.
Line 3 of the information conveyed from the originator of the message to the beneficiary.
Line 4 of the information conveyed from the originator of the message to the beneficiary.
The Account Number from which the recipient of this request is being requested to send funds.
A constant representing the object's type. For this resource it will always be inbound_wire_drawdown_request.
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 identifier of the Inbound Wire Drawdown Request to retrieve.
Simulates receiving an Inbound Wire Drawdown Request.
The amount being requested in cents.
The drawdown request's beneficiary's account number.
Line 1 of the drawdown request's beneficiary's address.
Line 2 of the drawdown request's beneficiary's address.
Line 3 of the drawdown request's beneficiary's address.
The drawdown request's beneficiary's name.
The drawdown request's beneficiary's routing number.
The ISO 4217 code for the amount being requested. Will always be "USD".
A message from the drawdown request's originator.
The drawdown request's originator's account number.
Line 1 of the drawdown request's originator's address.
Line 2 of the drawdown request's originator's address.
Line 3 of the drawdown request's originator's address.
The drawdown request's originator's name.
The drawdown request's originator's routing number.
Line 1 of the information conveyed from the originator of the message to the beneficiary.
Line 2 of the information conveyed from the originator of the message to the beneficiary.
Line 3 of the information conveyed from the originator of the message to the beneficiary.
Line 4 of the information conveyed from the originator of the message to the beneficiary.
The Account Number to which the recipient of this request is being requested to send funds from.
Check Transfers move funds from your Increase account by mailing a physical check.
The identifier of the Account from which funds will be transferred.
The account number printed on the check.
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.
If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit.
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
The check number printed on the check.
The ISO 8601 date and time at which the transfer was created.
What object created the transfer, either via the API or the dashboard.
Whether Increase will print and mail the check or if you will do it yourself.
The Check 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.
If the check has been mailed by Increase, this will contain details of the shipment.
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.
Details relating to the physical check that Increase will print and mail. Will be present if and only if fulfillment_method is equal to physical_check.
The routing number printed on the check.
The identifier of the Account Number from which to send the transfer and print on the check.
The lifecycle status of the transfer.
After a stop-payment is requested on the check, this will contain supplemental details.
After the transfer is submitted, this will contain supplemental details.
Details relating to the custom fulfillment you will perform. Will be present if and only if fulfillment_method is equal to third_party.
A constant representing the object's type. For this resource it will always be check_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 Check 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.
Filter Check Transfers to those that have the specified status. 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 for the account that will send the transfer.
The transfer amount in USD cents.
The check number Increase should use for the check. This should not contain leading zeroes and must be unique across the source_account_number. If this is omitted, Increase will generate a check number for you.
Whether Increase will print and mail the check or if you will do it yourself.
Details relating to the physical check that Increase will print and mail. This is required if fulfillment_method is equal to physical_check. It must not be included if any other fulfillment_method is provided.
Whether the transfer requires explicit approval via the dashboard or API.
The identifier of the Account Number from which to send the transfer and print on the check.
Details relating to the custom fulfillment you will perform. This is required if fulfillment_method is equal to third_party. It must not be included if any other fulfillment_method is provided.
The identifier of the Check Transfer.
The identifier of the Check Transfer to approve.
The identifier of the pending Check Transfer to cancel.
The identifier of the Check Transfer.
The reason why this transfer should be stopped.
Simulates the mailing of a Check Transfer, which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a status of pending_approval or pending_submission.
The identifier of the Check Transfer you wish to mail.
Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.
If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.
The Account the check is being deposited against.
The Account Number the check is being deposited against.
If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.
The deposited amount in USD cents.
The ID for the File containing the image of the back of the check.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.
The check number printed on the check being deposited.
If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.
The ISO 8601 date and time at which the deposit was attempted.
If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.
If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.
If you requested a return of this deposit, this will contain details of the return.
The ID for the File containing the image of the front of the check.
The deposit's identifier.
Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.
The status of the Inbound Check Deposit.
If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.
A constant representing the object's type. For this resource it will always be inbound_check_deposit.
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 Check Deposits to those belonging to the specified Account.
Filter Inbound Check Deposits to those belonging to the specified Check Transfer.
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 Inbound Check Deposit to get details for.
The identifier of the Inbound Check Deposit to decline.
The identifier of the Inbound Check Deposit to return.
The reason to return the Inbound Check Deposit.
Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.
The identifier of the Account Number the Inbound Check Deposit will be against.
The check amount in cents.
The check number on the check to be deposited.
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
The Account from which the transfer was sent.
If the transfer is acknowledged by the recipient bank, this will contain supplemental details.
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.
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 name of the transfer's recipient. This is set by the sender when creating the transfer.
The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.
The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
The destination account number.
The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
The identifier of the External Account the transfer was made to, if any.
The Real-Time Payments 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 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 the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
Unstructured information that will show on the recipient's bank statement.
The Account Number the recipient will see as having sent the transfer.
The lifecycle status of the transfer.
After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
The Transaction funding the transfer once it is complete.
A constant representing the object's type. For this resource it will always be real_time_payments_transfer.
The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.
The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.
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 Real-Time Payments Transfers to those belonging to the specified Account.
Filter Real-Time Payments 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 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.
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 transfer amount in USD cents. For Real-Time Payments transfers, must be positive.
The name of the transfer's recipient.
The name of the transfer's sender. If not provided, defaults to the name of the account's entity.
The destination account number.
The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
The ID of an External Account to initiate a transfer to. If this parameter is provided, destination_account_number and destination_routing_number must be absent.
Unstructured information that will show on the recipient's bank statement.
Whether the transfer requires explicit approval via the dashboard or API.
The identifier of the Account Number from which to send the transfer.
The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.
The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.
The identifier of the Real-Time Payments Transfer.
Simulates submission of a Real-Time Payments Transfer and handling the response from the destination financial institution. This transfer must first have a status of pending_submission.
The identifier of the Real-Time Payments Transfer you wish to complete.
If set, the simulation will reject the transfer.
An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.
The Account to which the transfer was sent.
The identifier of the Account Number to which this transfer was sent.
The amount in USD cents.
If your transfer is confirmed, this will contain details of the confirmation.
The ISO 8601 date and time at which the transfer was created.
The name the sender of the transfer specified as the recipient of the transfer.
The ISO 4217 code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
The account number of the account that sent the transfer.
The name provided by the sender of the transfer.
The routing number of the account that sent the transfer.
If your transfer is declined, this will contain details of the decline.
The inbound Real-Time Payments transfer's identifier.
Additional information included with the transfer.
The lifecycle status of the transfer.
The Real-Time Payments network identification of the transfer.
A constant representing the object's type. For this resource it will always be inbound_real_time_payments_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 Real-Time Payments Transfers to those belonging to the specified Account.
Filter Inbound Real-Time Payments Transfers 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.
The identifier of the Inbound Real-Time Payments Transfer to get details for.
Simulates an Inbound Real-Time Payments Transfer to your account. Real-Time Payments are a beta feature.
The identifier of the Account Number the inbound Real-Time Payments Transfer is for.
The transfer amount in USD cents. Must be positive.
The account number of the account that sent the transfer.
The name provided by the sender of the transfer.
The routing number of the account that sent the transfer.
Additional information included with the transfer.
The identifier of a pending Request for Payment that this transfer will fulfill.
Check Deposits allow you to deposit images of paper checks into your account.
The Account the check was deposited into.
The deposited amount in USD cents.
The ID for the File containing the image of the back of the check.
The ISO 8601 date and time at which the transfer was created.
If your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.
If your deposit is rejected by Increase, this will contain details as to why it was rejected.
If your deposit is returned, this will contain details as to why it was returned.
After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.
The description of the Check Deposit, for display purposes only.
The ID for the File containing the image of the front of the check.
The deposit'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 Check Deposits. If funds are held, this sub-object will contain details of the hold.
If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.
If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Lockbox that received it.
The status of the Check Deposit.
The ID for the Transaction created by the deposit.
A constant representing the object's type. For this resource it will always be check_deposit.
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 Check Deposits 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 identifier for the Account to deposit the check in.
The deposit amount in USD cents.
The File containing the check's back image.
The description you choose to give the Check Deposit, for display purposes only.
The File containing the check's front image.
The identifier of the Check Deposit to retrieve.
Simulates the rejection of a Check Deposit by Increase due to factors like poor image quality. This Check Deposit must first have a status of pending.
The identifier of the Check Deposit you wish to reject.
Simulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.
The identifier of the Check Deposit you wish to return.
Simulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.
The identifier of the Check Deposit you wish to submit.
Lockboxes are physical locations that can receive mail containing paper checks. Increase will automatically create a Check Deposit for checks received this way.
The identifier for the Account checks sent to this lockbox will be deposited into.
The mailing address for the Lockbox.
The ISO 8601 time at which the Lockbox was created.
The description you choose for the Lockbox.
The Lockbox 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 recipient name you choose for the Lockbox.
This indicates if mail can be sent to this address.
A constant representing the object's type. For this resource it will always be lockbox.
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 Lockboxes to those associated with the provided 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 checks sent to this Lockbox should be deposited into.
The description you choose for the Lockbox, for display purposes.
The name of the recipient that will receive mail at this location.
The identifier of the Lockbox to retrieve.
The identifier of the Lockbox.
The description you choose for the Lockbox.
The recipient name you choose for the Lockbox.
This indicates if checks can be sent to the Lockbox.
Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.
The ISO 8601 time at which the Inbound Mail Item was created.
The identifier for the File containing the scanned contents of the mail item.
The Inbound Mail Item identifier.
The identifier for the Lockbox that received this mail item. For mail items that could not be processed due to an invalid address, this will be null.
The recipient name as written on the mail item.
If the mail item has been rejected, why it was rejected.
If the mail item has been processed.
A constant representing the object's type. For this resource it will always be inbound_mail_item.
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 Mail Items to ones sent to the provided Lockbox.
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 Inbound Mail Item to retrieve.
Simulates an inbound mail item to your account, as if someone had mailed a physical check to one of your account's Lockboxes.
The amount of the check to be simulated, in cents.
The file containing the PDF contents. If not present, a default check image file will be used.
The identifier of the Lockbox to simulate inbound mail to.
Cards are commercial credit cards. They'll immediately work for online purchases after you create them. All cards maintain a credit limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
The identifier for the account this card belongs to.
The Card's billing address.
The ISO 8601 date and time at which the Card was created.
The card's description for display purposes.
The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
The identifier for the entity associated with this card.
The month the card expires in M format (e.g., August is 8).
The year the card expires in YYYY format (e.g., 2025).
The card 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 last 4 digits of the Card's Primary Account Number.
This indicates if payments can be made with the card.
A constant representing the object's type. For this resource it will always be card.
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 Cards 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 Cards by status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 card should belong to.
The card's billing address.
The description you choose to give the card.
The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category digital_wallet_token_requested or digital_wallet_authentication_requested.
The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.
The identifier of the Card.
The card identifier.
The card's updated billing address.
The description you choose to give the card.
The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.
The status to update the Card with.
The identifier of the Card to retrieve details for.
Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
The identifier for the Account the Transaction belongs to.
The Card identifier for this payment.
The ISO 8601 time at which the Card Payment was created.
The Digital Wallet Token identifier for this payment.
The interactions related to this card payment.
The Card Payment identifier.
The Physical Card identifier for this payment.
The summarized state of this card payment.
A constant representing the object's type. For this resource it will always be card_payment.
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 Card Payments to ones belonging to the specified Account.
Filter Card Payments to ones belonging to the specified Card.
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 Card Payment.
Simulates expiring a Card Authorization immediately.
The identifier of the Card Payment to expire.
Simulates a purchase authorization on a Card. Depending on the balance available to the card and the amount submitted, the authorization activity will result in a Pending Transaction of type card_authorization or a Declined Transaction of type card_decline. You can pass either a Card id or a Digital Wallet Token id to simulate the two different ways purchases can be made.
The authorization amount in cents.
The identifier of a Card Payment with a card_authentication if you want to simulate an authenticated authorization.
The identifier of the Card to be authorized.
Forces a card decline with a specific reason. No real time decision will be sent.
The identifier of the Digital Wallet Token to be authorized.
The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.
The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.
The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
The city the merchant resides in.
The country the merchant resides in.
The merchant descriptor of the merchant the card is transacting with.
The state the merchant resides in.
Fields specific to a given card network.
The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.
The identifier of the Physical Card to be authorized.
The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.
Simulates the fuel confirmation of an authorization by a card acquirer. This happens asynchronously right after a fuel pump transaction is completed. A fuel confirmation can only happen once per authorization.
The amount of the fuel_confirmation in minor units in the card authorization's currency.
The identifier of the Card Payment to create a fuel_confirmation on.
Simulates the increment of an authorization by a card acquirer. An authorization can be incremented multiple times.
The amount of the increment in minor units in the card authorization's currency.
The identifier of the Card Payment to create a increment on.
The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.
Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.
The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement.
Simulates the reversal of an authorization by a card acquirer. An authorization can be partially reversed multiple times, up until the total authorized amount. Marks the pending transaction as complete if the authorization is fully reversed.
The amount of the reversal in minor units in the card authorization's currency. This defaults to the authorization amount.
The identifier of the Card Payment to create a reversal on.
Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill.
The amount to be settled. This defaults to the amount of the Pending Transaction being settled.
The identifier of the Card to create a settlement on.
The identifier of the Pending Transaction for the Card Authorization you wish to settle.
Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
The ID of the Card Payment this transaction belongs to.
The Card Purchase Supplement identifier.
Invoice-level information about the payment.
Line item information, such as individual products purchased.
The ID of the transaction.
A constant representing the object's type. For this resource it will always be card_purchase_supplement.
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 Card Purchase Supplements to ones belonging to the specified Card Payment.
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 Card Purchase Supplement.
If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.
If the Card Dispute's status is accepted, this will contain details of the successful dispute.
The amount of the dispute, if provided, or the transaction amount otherwise.
The ISO 8601 date and time at which the Card Dispute was created.
The identifier of the Transaction that was disputed.
Why you disputed the Transaction in question.
The Card Dispute 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 Card Dispute's status is lost, this will contain details of the lost dispute.
If the Card Dispute's status is rejected, this will contain details of the unsuccessful dispute.
The results of the Dispute investigation.
A constant representing the object's type. For this resource it will always be card_dispute.
If the Card Dispute's status is won, this will contain details of the won dispute.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
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 Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.
The Transaction you wish to dispute. This Transaction must have a source_type of card_settlement.
Why you are disputing this Transaction.
The identifier of the Card Dispute.
After a Card Dispute is created in production, the dispute will be reviewed. Since no review happens in sandbox, this endpoint simulates moving a Card Dispute into a rejected or accepted state. A Card Dispute can only be actioned one time and must have a status of pending_reviewing.
The dispute you would like to action.
Why the dispute was rejected. Not required for accepting disputes.
The status to move the dispute to.
Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected Card Profile. The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact support@increase.com for pricing!
The identifier for the Card this Physical Card represents.
Details about the cardholder, as it appears on the printed card.
The ISO 8601 date and time at which the Physical Card was created.
The physical card 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 Physical Card Profile used for this Physical Card.
The details used to ship this physical card.
The status of the Physical Card.
A constant representing the object's type. For this resource it will always be physical_card.
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 Physical Cards to ones belonging to the specified Card.
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 underlying card representing this physical card.
Details about the cardholder, as it will appear on the physical card.
The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.
The details used to ship this physical card.
The identifier of the Physical Card.
The Physical Card identifier.
The status to update the Physical Card to.
This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery.
The Physical Card you would like to action.
The shipment status to move the Physical Card to.
This endpoint allows you to simulate receiving a tracking update for a Physical Card, to simulate the progress of a shipment.
The Physical Card you would like to action.
The ISO 8601 date and time when the carrier expects the card to be delivered.
The type of tracking event.
The city where the event took place.
The postal code where the event took place.
The state where the event took place.
This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on digital card artwork.
The identifier of the File containing the card's icon image.
The identifier of the File containing the card's front image.
A user-facing description for the card itself.
An email address the user can contact to receive support for their card.
A phone number the user can contact to receive support for their card.
A website the user can visit to view and receive support for their card.
The ISO 8601 date and time at which the Card Dispute was created.
A description you can use to identify the Card Profile.
The Card Profile 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.
A user-facing description for whoever is issuing the card.
The status of the Card Profile.
The Card's text color, specified as an RGB triple.
A constant representing the object's type. For this resource it will always be digital_card_profile.
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 Digital Card Profiles for those with the specified digital wallet status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 of the File containing the card's icon image.
The identifier of the File containing the card's front image.
A user-facing description for the card itself.
An email address the user can contact to receive support for their card.
A phone number the user can contact to receive support for their card.
A website the user can visit to view and receive support for their card.
A description you can use to identify the Card Profile.
A user-facing description for whoever is issuing the card.
The Card's text color, specified as an RGB triple. The default is white.
The identifier of the Digital Card Profile.
The identifier of the Digital Card Profile to archive.
The identifier of the Digital Card Profile to clone.
The identifier of the File containing the card's icon image.
The identifier of the File containing the card's front image.
A user-facing description for the card itself.
An email address the user can contact to receive support for their card.
A phone number the user can contact to receive support for their card.
A website the user can visit to view and receive support for their card.
A description you can use to identify the Card Profile.
A user-facing description for whoever is issuing the card.
The Card's text color, specified as an RGB triple. The default is white.
This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on physical card artwork.
The identifier of the File containing the physical card's back image.
The identifier of the File containing the physical card's carrier image.
A phone number the user can contact to receive support for their card.
The ISO 8601 date and time at which the Card Dispute was created.
The creator of this Physical Card Profile.
A description you can use to identify the Physical Card Profile.
The identifier of the File containing the physical card's front image.
The Card Profile 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.
Whether this Physical Card Profile is the default for all cards in its Increase group.
The identifier for the Program this Physical Card Profile belongs to.
The status of the Physical Card Profile.
A constant representing the object's type. For this resource it will always be physical_card_profile.
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 Physical Card Profiles for those with the specified statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 of the File containing the physical card's carrier image.
A phone number the user can contact to receive support for their card.
A description you can use to identify the Card Profile.
The identifier of the File containing the physical card's front image.
Text printed on the front of the card. Reach out to support@increase.com for more information.
The identifier for the Program that this Physical Card Profile falls under.
The identifier of the Card Profile.
The identifier of the Physical Card Profile to archive.
The identifier of the Physical Card Profile to clone.
The identifier of the File containing the physical card's carrier image.
A phone number the user can contact to receive support for their card.
A description you can use to identify the Card Profile.
The identifier of the File containing the physical card's front image.
Text printed on the front of the card. Reach out to support@increase.com for more information.
A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.
The identifier for the Card this Digital Wallet Token belongs to.
The cardholder information given when the Digital Wallet Token was created.
The ISO 8601 date and time at which the Digital Wallet Token was created.
The device that was used to create the Digital Wallet Token.
The Digital Wallet Token identifier.
This indicates if payments can be made with the Digital Wallet Token.
The digital wallet app being used.
A constant representing the object's type. For this resource it will always be digital_wallet_token.
Updates to the Digital Wallet Token.
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 Digital Wallet Tokens to ones belonging to the specified Card.
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 Digital Wallet Token.
Simulates a user attempting add a Card to a digital wallet such as Apple Pay.
The identifier of the Card to be authorized.
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts.
Details of the corporation entity. Will be present if structure is equal to corporation.
The ISO 8601 time at which the Entity was created.
The entity's description for display purposes.
The ISO 8601 time at which the Entity's details were most recently confirmed.
Details of the government authority entity. Will be present if structure is equal to government_authority.
The entity'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.
Details of the joint entity. Will be present if structure is equal to joint.
Details of the natural person entity. Will be present if structure is equal to natural_person.
The status of the entity.
The entity's legal structure.
Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them.
A reference to data stored in a third-party verification service. Your integration may or may not use this field.
Details of the trust entity. Will be present if structure is equal to trust.
A constant representing the object's type. For this resource it will always be entity.
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 Entities for those with the specified status or statuses. 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.
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.
Details of the corporation entity to create. Required if structure is equal to corporation.
The description you choose to give the entity.
Details of the Government Authority entity to create. Required if structure is equal to Government Authority.
Details of the joint entity to create. Required if structure is equal to joint.
Details of the natural person entity to create. Required if structure is equal to natural_person. Natural people entities should be submitted with social_security_number or individual_taxpayer_identification_number identification methods.
The type of Entity to create.
Additional documentation associated with the entity.
A reference to data stored in a third-party verification service. Your integration may or may not use this field.
Details of the trust entity to create. Required if structure is equal to trust.
The identifier of the Entity to retrieve.
The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.
The identifier of the Entity associated with the Beneficial Owner that is being archived.
The identifying details of anyone controlling or owning 25% or more of the corporation.
Depending on your program, you may be required to re-confirm an Entity's details on a recurring basis. After making any required updates, call this endpoint to record that your user confirmed their details.
The identifier of the Entity to confirm the details of.
When your user confirmed the Entity's details. If not provided, the current time will be used.
The identifier of the Entity to associate with the new Beneficial Owner.
The identifying details of anyone controlling or owning 25% or more of the corporation.
The identifier of the Entity whose address is being updated.
The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
The identifier of the Entity associated with the Beneficial Owner whose address is being updated.
The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.
The identifying details of anyone controlling or owning 25% or more of the corporation.
The identifier of the Entity to update. This endpoint only accepts corporation entities.
The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like 5132 for Software Publishers. A full list of classification codes is available here.
Supplemental Documents are uploaded files connected to an Entity during onboarding.
The ISO 8601 time at which the Supplemental Document was created.
The Entity the supplemental document is attached to.
The File containing the document.
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.
A constant representing the object's type. For this resource it will always be entity_supplemental_document.
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 identifier of the Entity to list supplemental documents for.
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 of the Entity to associate with the supplemental document.
The identifier of the File containing the document.
Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
The Bank the Program is with.
The Program billing account.
The ISO 8601 time at which the Program was created.
The default configuration for digital cards attached to this Program.
The Program identifier.
The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as "0.01".
The name of the Program.
A constant representing the object's type. For this resource it will always be program.
The ISO 8601 time at which the Program was last updated.
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 identifier of the Program to retrieve.
Simulates a Program being created in your group. By default, your group has one program called Commercial Banking. Note that when your group operates more than one program, program_id is a required field when creating accounts.
The name of the program being added.
The identifier of the Account the Program should be added to is for.
Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our webhooks guide.
The identifier of the object that generated this Event.
The type of the object that generated this Event.
The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
The time the Event was created.
The Event identifier.
A constant representing the object's type. For this resource it will always be event.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
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 Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
Filter Events to those belonging to the object with the provided identifier.
The identifier of the Event.
Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your developer dashboard or the API. For more information, see our webhooks guide.
The time the event subscription was created.
The event subscription 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 specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.
If specified, this subscription will only receive webhooks for Events with the specified category.
This indicates if we'll send notifications to this subscription.
A constant representing the object's type. For this resource it will always be event_subscription.
The webhook url where we'll send notifications.
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.
If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection.
If specified, this subscription will only receive webhooks for Events with the specified category.
The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.
The URL you'd like us to send webhooks to.
The identifier of the Event Subscription.
The identifier of the Event Subscription.
The status to update the Event Subscription with.
Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our Real-Time Decisions guide.
Fields related to a 3DS authentication attempt.
Fields related to a 3DS authentication attempt.
Fields related to a card authorization.
The category of the Real-Time Decision.
The ISO 8601 date and time at which the Real-Time Decision was created.
Fields related to a digital wallet authentication attempt.
Fields related to a digital wallet token provisioning attempt.
The Real-Time Decision identifier.
The status of the Real-Time Decision.
The ISO 8601 date and time at which your application can no longer respond to the Real-Time Decision.
A constant representing the object's type. For this resource it will always be real_time_decision.
The identifier of the Real-Time Decision.
The identifier of the Real-Time Decision.
If the Real-Time Decision relates to a 3DS card authentication attempt, this object contains your response to the authentication.
If the Real-Time Decision relates to 3DS card authentication challenge delivery, this object contains your response.
If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.
If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.
If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.
Routing numbers are used to identify your bank in a financial transaction.
This routing number's support for ACH Transfers.
The name of the financial institution belonging to a routing number.
This routing number's support for Real-Time Payments Transfers.
The nine digit routing number identifier.
A constant representing the object's type. For this resource it will always be routing_number.
This routing number's support for Wire Transfers.
You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.
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 financial institutions by routing number.
External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.
The type of entity that owns the External Account.
The destination account number.
The ISO 8601 date and time at which the External Account was created.
The External Account's description for display purposes.
The type of the account to which the transfer will be sent.
The External Account'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 American Bankers' Association (ABA) Routing Transit Number (RTN).
The External Account's status.
A constant representing the object's type. For this resource it will always be external_account.
If you have verified ownership of the External 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 External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
Filter External Accounts to those with the specified Routing Number.
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 type of entity that owns the External Account.
The account number for the destination account.
The name you choose for the Account.
The type of the destination account. Defaults to checking.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
The identifier of the External Account.
The external account identifier.
The type of entity that owns the External Account.
The description you choose to give the external account.
The funding type of the External Account.
The status of the External Account.
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.
The identifier for the Account this Account Statement belongs to.
The ISO 8601 time at which the Account Statement was created.
The Account's balance at the start of its statement period.
The identifier of the File containing a PDF of the statement.
The Account Statement identifier.
The Account's balance at the start of its statement period.
The ISO 8601 time representing the end of the period the Account Statement covers.
The ISO 8601 time representing the start of the period the Account Statement covers.
A constant representing the object's type. For this resource it will always be account_statement.
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 Statements 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.
The identifier of the Account Statement to retrieve.
Simulates an Account Statement being created for an account. In production, Account Statements are generated once per month.
The identifier of the Account the statement is for.
Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.
The time the File was created.
A description of the File.
Whether the File was generated by Increase or by you and sent to Increase.
The filename that was provided upon upload or generated by Increase.
The File'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 MIME type of the file.
What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
A constant representing the object's type. For this resource it will always be file.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
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 Files for those with the specified purpose or purposes. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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.
To upload a file to Increase, you'll need to send a request of Content-Type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
The description you choose to give the File.
The file contents. This should follow the specifications of RFC 7578 which defines file transfers for the multipart/form-data protocol.
What the File will be used for in Increase's systems.
The identifier of the File.
File Links let you generate a URL that can be used to download a File.
The ISO 8601 time at which the File Link was created.
The ISO 8601 time at which the File Link will expire.
The identifier of the File the File Link points to.
The File Link 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.
A constant representing the object's type. For this resource it will always be file_link.
A URL where the File can be downloaded. The URL will expire after the expires_at time. This URL is unauthenticated and can be used to download the File without an Increase API key.
The time at which the File Link will expire. The default is 1 hour from the time of the request. The maxiumum is 1 day from the time of the request.
The File to create a File Link for.
Increase generates certain documents / forms automatically for your application; they can be listed here.
The type of document.
The ISO 8601 time at which the Document was created.
The identifier of the Entity the document was generated for.
The identifier of the File containing the Document's contents.
The Document identifier.
A constant representing the object's type. For this resource it will always be document.
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 Documents to ones belonging to the specified Entity.
Filter Documents for those with the specified category or categories. 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 Document to retrieve.
Simulates an tax document being created for an account.
The identifier of the Account the tax document is for.
Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our Exports documentation.
The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.
The time the Export was created.
A URL at which the Export's file can be downloaded. This will be present when the Export's status transitions to complete.
The File containing the contents of the Export. This will be present when the Export's status transitions to complete.
The Export 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 status of the Export.
A constant representing the object's type. For this resource it will always be export.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
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 Exports for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
Filter Exports for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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.
Options for the created export. Required if category is equal to account_statement_ofx.
Options for the created export. Required if category is equal to balance_csv.
Options for the created export. Required if category is equal to bookkeeping_account_balance_csv.
The type of Export to create.
Options for the created export. Required if category is equal to entity_csv.
Options for the created export. Required if category is equal to transaction_csv.
Options for the created export. Required if category is equal to vendor_csv.
The identifier of the Export to retrieve.
Accounts are T-accounts. They can store accounting entries. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.
The API Account associated with this bookkeeping account.
The compliance category of the account.
The Entity associated with this bookkeeping account.
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 name you choose for the account.
A constant representing the object's type. For this resource it will always be bookkeeping_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 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 entity, if compliance_category is commingled_cash.
The account compliance category.
The entity, if compliance_category is customer_balance.
The name you choose for the account.
The bookkeeping account you would like to update.
The name you choose for the account.
The identifier of the Bookkeeping Account to retrieve.
The moment to query the balance at. If not set, returns the current balances.
Entry Sets are accounting entries that are transactionally applied. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.
When the entry set was created.
The timestamp of the entry set.
The entries.
The entry set 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 transaction identifier, if any.
A constant representing the object's type. For this resource it will always be bookkeeping_entry_set.
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 to the Bookkeeping Entry Set that maps to this Transaction.
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 date of the transaction. Optional if transaction_id is provided, in which case we use the date of that transaction. Required otherwise.
The bookkeeping entries.
The identifier of the Transaction related to this entry set, if any.
The identifier of the Bookkeeping Entry Set.
Entries are T-account entries recording debits and credits. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.
The identifier for the Account the Entry belongs to.
The Entry amount in the minor unit of its currency. For dollars, for example, this is cents.
When the entry set was created.
The identifier for the Account the Entry belongs to.
The entry identifier.
A constant representing the object's type. For this resource it will always be bookkeeping_entry.
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 identifier for the Bookkeeping Account to filter by.
The identifier of the Bookkeeping Entry.
Groups represent organizations using Increase. You can retrieve information about your own organization via the API. More commonly, OAuth platforms can retrieve information about the organizations that have granted them access. Learn more about OAuth here.
If the Group is allowed to create ACH debits.
If the Group is activated or not.
The ISO 8601 time at which the Group was created.
The Group identifier.
A constant representing the object's type. For this resource it will always be group.
Returns details for the currently authenticated Group.
An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth here.
The OAuth Application's client_id. Use this to authenticate with the OAuth Application.
The ISO 8601 timestamp when the OAuth Application was created.
The ISO 8601 timestamp when the OAuth Application was deleted.
The OAuth Application's identifier.
The name you chose for this OAuth Application.
Whether the application is active.
A constant representing the object's type. For this resource it will always be oauth_application.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
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.
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 OAuth Application.
When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth here.
The ISO 8601 timestamp when the OAuth Connection was created.
The ISO 8601 timestamp when the OAuth Connection was deleted.
The identifier of the Group that has authorized your OAuth application.
The OAuth Connection's identifier.
The identifier of the OAuth application this connection is for.
Whether the connection is active.
A constant representing the object's type. For this resource it will always be oauth_connection.
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 to OAuth Connections by their status. By default, return only the active ones. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
Filter results to only include OAuth Connections for a specific OAuth Application.
The identifier of the OAuth Connection.
A token that is returned to your application when a user completes the OAuth flow and may be used to authenticate requests. Learn more about OAuth here.
You may use this token in place of an API key to make OAuth requests on a user's behalf.
The type of OAuth token.
A constant representing the object's type. For this resource it will always be oauth_token.
The public identifier for your application.
The secret that confirms you own the application. This is redundent given that the request is made with your API key but it's a required component of OAuth 2.0.
The authorization code generated by the user and given to you as a query parameter.
The credential you request in exchange for the code. In Production, this is always authorization_code. In Sandbox, you can pass either enum value.
The production token you want to exchange for a sandbox token. This is only available in Sandbox. Set grant_type to production_token to use this parameter.
IntraFi is a network of financial institutions that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.
The identifier of the Increase Account being swept into the network.
The ISO 8601 date and time at which the enrollment was created.
The identifier of this enrollment at IntraFi.
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 the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.
The status of the account in the network. An account takes about one business day to go from pending_enrolling to enrolled.
A constant representing the object's type. For this resource it will always be intrafi_account_enrollment.
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 IntraFi Account Enrollments to the one belonging to an account.
Filter IntraFi Account Enrollments for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
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 account to be added to IntraFi.
The contact email for the account owner, to be shared with IntraFi.
The identifier of the IntraFi Account Enrollment to retrieve.
The Identifier of the IntraFi Account Enrollment to remove from IntraFi.
When using IntraFi, each account's balance over the standard FDIC insurance amount is swept to various other institutions. Funds are rebalanced across banks as needed once per business day.
Each entry represents a balance held at a different bank. IntraFi separates the total balance across many participating banks in the network.
The date this balance reflects.
The identifier of this balance.
The total balance, in minor units of currency. Increase reports this balance to IntraFi daily.
A constant representing the object's type. For this resource it will always be intrafi_balance.
Returns the IntraFi balance for the given account. IntraFi may sweep funds to multiple banks. This endpoint will include both the total balance and the amount swept to each institution.
The identifier of the Account to get balances for.
Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.
The name of the excluded institution.
The ISO 8601 date and time at which the exclusion was created.
The entity for which this institution is excluded.
When this was exclusion was confirmed by IntraFi.
The Federal Deposit Insurance Corporation's certificate number for the institution.
The identifier of this exclusion request.
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 status of the exclusion request.
When this was exclusion was submitted to IntraFi by Increase.
A constant representing the object's type. For this resource it will always be intrafi_exclusion.
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 IntraFi Exclusions for those belonging to the specified Entity.
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 name of the financial institution to be excluded.
The identifier of the Entity whose deposits will be excluded.
The identifier of the IntraFi Exclusion to retrieve.
The identifier of the IntraFi Exclusion request to archive. It may take 5 business days for an exclusion removal to be processed. Removing an exclusion does not guarantee that funds will be swept to the previously-excluded bank.