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 7807 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. We recommend using a V4 UUID. Reusing the key in subsequent requests will return the same response code and body as the original request along with an additional HTTP header (Idempotent-Replayed: true). This applies to both success and error responses. In situations where your request results in a validation error, you'll need to update your request and retry with a new idempotency key.
Idempotency keys will persist in the API for at least 1 hour. If an original request is still being processed when an idempotency key is reused, the API will return a 409 Conflict error. Subsequent requests must be identical to the original request or the API will return a 422 Unprocessable Entity error. We discourage setting an idempotency key on GET and DELETE requests as these requests are inherently idempotent.
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 created.
The identifier for the Entity the Account belongs to.
The identifier of an Entity that, while not owning the Account, is associated with its activity.
The Account identifier.
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 status of the Account.
A constant representing the object's type. For this resource it will always be account.
The identifier for the Entity that will own the Account.
The identifier for the Program that this Account falls under. Required if you operate more than one Program.
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.
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 with the specified status.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
The identifier of the Account to update.
The new name of the Account.
The identifier of the Account to retrieve.
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.
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 Account Number identifier.
The ISO 8601 time at which the Account Number was created.
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.
Properties related to how this Account Number handles inbound ACH transfers.
Properties related to how this Account Number should handle inbound check withdrawls.
A constant representing the object's type. For this resource it will always be account_number.
The Account the Account Number should belong to.
The name you choose for the Account Number.
Options related to how this Account Number should handle inbound ACH transfers.
Options related to how this Account Number should handle inbound check withdrawls.
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.
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.
The identifier of the Account Number.
The name you choose for the Account Number.
This indicates if transfers can be made to the Account Number.
Options related to how this Account Number handles inbound ACH transfers.
The identifier of the Account Number to retrieve.
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 Account Statement identifier.
The identifier for the Account this Account Statement belongs to.
The ISO 8601 time at which the Account Statement was created.
The identifier of the File containing a PDF of the statement.
The ISO 8601 time representing the start of the period the Account Statement covers.
The ISO 8601 time representing the end of the period the Account Statement covers.
The Account's balance at the start of its statement period.
The Account's balance at the start of its statement period.
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.
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 4217 code for the Transaction's currency. This will match the currency on the Transaction's Account.
The ISO 8601 date on which the Transaction occurred.
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 4217 code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
The ISO 8601 date on which the Pending Transaction was completed.
The ISO 8601 date on which the Pending Transaction occurred.
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.
Filter pending transactions to those caused by the specified source.
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.
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 4217 code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
The ISO 8601 date on which the Transaction occurred.
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 transfer's identifier.
The transfer amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
The Account to which the transfer belongs.
The destination account's identifier.
The ID for the transaction receiving the transfer.
The ISO 8601 date and time at which the transfer was created.
The description that will show on the transactions.
The transfer's network.
The lifecycle status of the transfer.
The ID for the transaction funding the transfer.
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 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 unique identifier you chose for this transfer.
A constant representing the object's type. For this resource it will always be account_transfer.
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.
A unique identifier you choose for the transfer. Reusing this identifier for another transfer will result in an error. You can query for the transfer associated with this identifier using the List endpoint.
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 Account Transfers to the one with the specified unique identifier.
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 Transfer.
The identifier of the Account Transfer to approve.
The identifier of the pending Account Transfer to cancel.
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.
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.
The ISO 4217 code for the transfer's currency. For ACH transfers this is always equal to usd.
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.
The identifier of the External Account the transfer was made to, if any.
The ACH transfer's identifier.
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.
If your transfer is returned, this will contain details of the return.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
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.
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.
The ID for the transaction funding the transfer.
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 description of the date of the transfer.
The data you chose to associate with the transfer.
The description of the transfer you set to be shown to the recipient.
The name by which the recipient knows you.
The 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 information and not verified by the recipient's bank.
The transfer effective date in ISO 8601 format.
The Standard Entry Class (SEC) code to use for the transfer.
The unique identifier you chose for this transfer.
A constant representing the object's type. For this resource it will always be ach_transfer.
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 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 transfer effective date in ISO 8601 format.
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.
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.
A unique identifier you choose for the transfer. Reusing this identifier for another transfer will result in an error. You can query for the transfer associated with this identifier using the List endpoint.
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 ACH Transfers to the one with the specified unique identifier.
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 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.
An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.
The inbound ach transfer's identifier.
The transfer amount in USD cents.
The identifier of the Account Number to which this transfer was sent.
The direction of the transfer.
The status of the transfer.
The name of the company that initiated the transfer.
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 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 trace number of the transfer.
The time at which the transfer will be automatically resolved.
Additional information sent from the originator.
If your transfer is accepted, this will contain details of the acceptance.
If your transfer is declined, this will contain details of the decline.
If your transfer is returned, this will contain details of the return.
If you initiate a notification of change in response to the transfer, this will contain its details.
A constant representing the object's type. For this resource it will always be inbound_ach_transfer.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
Filter Inbound ACH Tranfers to ones belonging to the specified Account.
Return results after this ISO 8601 timestamp.
Return results before this ISO 8601 timestamp.
Return results on or after this ISO 8601 timestamp.
Return results on or before this ISO 8601 timestamp.
Filter Inbound ACH Transfers to those with the specified status.
The identifier of the Inbound ACH Transfer to get details for.
The identifier of the Inbound ACH Transfer to decline.
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.
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.
Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
The wire transfer's identifier.
The message that will show on the recipient's bank statement.
The transfer amount in USD cents.
The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd.
The destination account number.
The beneficiary's name.
The beneficiary's address line 1.
The beneficiary's address line 2.
The beneficiary's address line 3.
The Account to which the transfer belongs.
The identifier of the External Account the transfer was made to, if any.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
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.
If your transfer is reversed, this will contain details of the reversal.
The ISO 8601 date and time at which the transfer was created.
The transfer's network.
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.
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 unique identifier you chose for this transfer.
A constant representing the object's type. For this resource it will always be wire_transfer.
The identifier for the account that will send the transfer.
The account number for the destination account.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
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 transfer amount in cents.
The message that will show on the recipient's bank statement.
The beneficiary's name.
The beneficiary's address line 1.
The beneficiary's address line 2.
The beneficiary's address line 3.
Whether the transfer requires explicit approval via the dashboard or API.
A unique identifier you choose for the transfer. Reusing this identifier for another transfer will result in an error. You can query for the transfer associated with this identifier using the List endpoint.
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 Wire Transfers to the one with the specified unique identifier.
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 Wire Transfer.
The identifier of the Wire Transfer to approve.
The identifier of the pending Wire Transfer to cancel.
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.
A constant representing the object's type. For this resource it will always be wire_drawdown_request.
The Wire drawdown request identifier.
The Account Number to which the recipient of this request is being requested to send funds.
The drawdown request's recipient's account number.
The drawdown request's recipient's routing number.
The amount being requested in cents.
The ISO 4217 code for the amount being requested. Will always be "USD".
The message the recipient will see as part of the drawdown request.
The drawdown request's recipient's name.
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.
After the drawdown request is submitted to Fedwire, this will contain supplemental details.
If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.
The lifecycle status of the drawdown request.
The Account Number to which the recipient should send funds.
The amount requested from the recipient, in cents.
A message the recipient will see as part of the request.
The drawdown request's recipient's account number.
The drawdown request's recipient's routing number.
The drawdown request's recipient's name.
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.
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 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.
A constant representing the object's type. For this resource it will always be inbound_wire_drawdown_request.
The Wire drawdown request identifier.
The Account Number from which the recipient of this request is being requested to send funds.
The drawdown request's originator's account number.
The drawdown request's originator's routing number.
The drawdown request's beneficiary's account number.
The drawdown request's beneficiary's routing number.
The amount being requested in cents.
The ISO 4217 code for the amount being requested. Will always be "USD".
A message from the drawdown request's originator.
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 drawdown request's originator's name.
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 beneficiary's name.
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.
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.
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 identifier of the Account Number from which to send the transfer and print on the check.
The account number printed on the check.
The routing number printed on the check.
The check number printed on the check.
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. Will be present if and only if fulfillment_method is equal to physical_check.
The transfer amount in USD cents.
The ISO 8601 date and time at which the transfer was created.
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 Check transfer's identifier.
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.
The lifecycle status of the transfer.
After the transfer is submitted, this will contain supplemental details.
After a stop-payment is requested on the check, this will contain supplemental details.
After a check transfer is deposited, this will contain supplemental details.
The unique identifier you chose for this transfer.
A constant representing the object's type. For this resource it will always be check_transfer.
The identifier for the account that will send the transfer.
The identifier of the Account Number from which to send the transfer and print on the check.
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.
The transfer amount in cents.
Whether the transfer requires explicit approval via the dashboard or API.
A unique identifier you choose for the transfer. Reusing this identifier for another transfer will result in an error. You can query for the transfer associated with this identifier using the List endpoint.
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 Check Transfers to the one with the specified unique identifier.
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 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.
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
A constant representing the object's type. For this resource it will always be real_time_payments_transfer.
The Real-Time Payments Transfer's identifier.
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 lifecycle status of the transfer.
The ISO 8601 date and time at which the transfer was created.
The Account from which the transfer was sent.
The identifier of the External Account the transfer was made to, if any.
The Account Number the recipient will see as having sent the transfer.
The name of the transfer's recipient as provided by the sender.
Unstructured information that will show on the recipient's bank statement.
The transfer amount in USD cents.
The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.
The destination account number.
The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
The Transaction funding the transfer once it is complete.
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.
After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
The unique identifier you chose for this transfer.
The identifier of the Account Number from which to send the transfer.
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.
The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.
The name of the transfer's recipient.
Unstructured information that will show on the recipient's bank statement.
Whether the transfer requires explicit approval via the dashboard or API.
A unique identifier you choose for the transfer. Reusing this identifier for another transfer will result in an error. You can query for the transfer associated with this identifier using the List endpoint.
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 ACH Transfers to the one with the specified unique identifier.
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 Real-Time Payments Transfer.
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 card identifier.
The identifier for the account this card belongs to.
The identifier for the entity associated with this card.
The ISO 8601 date and time at which the Card was created.
The card's description for display purposes.
The last 4 digits of the Card's Primary Account Number.
The month the card expires in M format (e.g., August is 8).
The year the card expires in YYYY format (e.g., 2025).
This indicates if payments can be made with the card.
The Card's billing address.
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.
A constant representing the object's type. For this resource it will always be card.
The Account the card should belong to.
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 description you choose to give the card.
The card's billing address.
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.
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.
The identifier of the Card to retrieve details for.
The card identifier.
The description you choose to give the card.
The status to update the Card with.
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 card's updated billing address.
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 of the Card.
Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
The Card Payment identifier.
The ISO 8601 time at which the Card Payment was created.
The identifier for the Account the Transaction belongs to.
The Card identifier for this payment.
The interactions related to this card 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.
If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.
The Card Dispute identifier.
Why you disputed the Transaction in question.
The results of the Dispute investigation.
The ISO 8601 date and time at which the Card Dispute was created.
The identifier of the Transaction that was disputed.
If the Card Dispute's status is accepted, this will contain details of the successful dispute.
If the Card Dispute's status is rejected, this will contain details of the unsuccessful dispute.
A constant representing the object's type. For this resource it will always be card_dispute.
The Transaction you wish to dispute. This Transaction must have a source_type of card_settlement.
Why you are disputing this 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.
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.
The identifier of the Card Dispute.
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 physical card identifier.
The identifier for the Card this Physical Card represents.
The Card Profile used for this Physical Card.
The ISO 8601 date and time at which the Physical Card was created.
The status of the Physical Card.
Details about the cardholder, as it appears on the printed card.
The details used to ship this physical card.
A constant representing the object's type. For this resource it will always be physical_card.
The underlying card representing this physical card.
The card profile to use for this physical card.
Details about the cardholder, as it will appear on the physical card.
The details used to ship this 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.
The Physical Card identifier.
The status to update the Physical Card to.
The identifier of the Physical Card.
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 Card Profile identifier.
The ISO 8601 date and time at which the Card Dispute was created.
The status of the Card Profile.
A description you can use to identify the Card Profile.
Whether this Card Profile is the default for all cards in its Increase group.
How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.
How physical cards should be designed and shipped.
A constant representing the object's type. For this resource it will always be card_profile.
A description you can use to identify the Card Profile.
How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.
How physical cards should be designed and shipped.
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 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 Card Profiles for those with the specified physical card status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
The identifier of the Card Profile.
The identifier of the Card Profile to archive.
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 Digital Wallet Token identifier.
The identifier for the Card this Digital Wallet Token belongs to.
The ISO 8601 date and time at which the Card was created.
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.
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.
Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
The Card Purchase Supplement identifier.
The ID of the transaction.
The ID of the Card Payment this transaction belongs to.
Invoice-level information about the payment.
Line item information, such as individual products purchased.
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.
Check Deposits allow you to deposit images of paper checks into your account.
The deposit's identifier.
The deposited amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
The ISO 8601 date and time at which the transfer was created.
The status of the Check Deposit.
The Account the check was deposited into.
The ID for the File containing the image of the front of the check.
The ID for the File containing the image of the back of the check.
The ID for the Transaction created by the deposit.
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.
A constant representing the object's type. For this resource it will always be check_deposit.
The identifier for the Account to deposit the check in.
The deposit amount in the minor unit of the account currency. For dollars, for example, this is cents.
The currency to use for the deposit.
The File containing the check's front image.
The File containing the check's back image.
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.
The identifier of the Check Deposit to retrieve.
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, or trusts.
The entity's identifier.
The entity's legal structure.
Details of the corporation entity. Will be present if structure is equal to corporation.
Details of the natural person entity. Will be present if structure is equal to natural_person.
Details of the joint entity. Will be present if structure is equal to joint.
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.
The entity's description for display purposes.
The status of the entity.
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.
The type of Entity to create.
Details of the corporation entity to create. Required if structure is equal to corporation.
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.
Details of the joint entity to create. Required if structure is equal to joint.
Details of the trust entity to create. Required if structure is equal to trust.
The description you choose to give the entity.
The relationship between your group and the entity.
Additional documentation associated with the 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.
The identifier of the Entity to retrieve.
The identifier of the Entity to archive.
The entity's physical address. Post Office Boxes are disallowed.
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 to retrieve.
The identifying details of anyone controlling or owning 25% or more of the corporation.
The individual's physical address. Post Office Boxes are disallowed.
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 to retrieve.
The identifying details of anyone controlling or owning 25% or more of the corporation.
Supplemental Documents are uploaded files connected to an Entity during onboarding.
The File containing the document.
The ISO 8601 time at which the Supplemental Document was created.
A constant representing the object's type. For this resource it will always be entity_supplemental_document.
The identifier of the Entity to associate with the supplemental document.
The identifier of the File containing the 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.
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 name of the Program.
The ISO 8601 time at which the Program was created.
The ISO 8601 time at which the Program was last updated.
The Program identifier.
A constant representing the object's type. For this resource it will always be program.
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.
A request for proof of authorization for one or more ACH debit transfers.
The Proof of Authorization Request identifier.
The time the Proof of Authorization Request was created.
The time the Proof of Authorization Request was last updated.
The ACH Transfers associated with the request.
A constant representing the object's type. For this resource it will always be proof_of_authorization_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.
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 Proof of Authorization Request.
Information submitted in response to a proof of authorization request. Per Nacha's guidance on proof of authorization, the originator must ensure that the authorization complies with applicable legal requirements, is readily identifiable as an authorization, and has clear and readily understandable terms.
The Proof of Authorization Request Submission identifier.
The time the Proof of Authorization Request Submission was created.
The time the Proof of Authorization Request Submission was last updated.
Name of the authorizer.
Email of the authorizer.
Company of the authorizer.
IP address of the authorizer.
Time of authorization.
Terms of authorization.
ID of the proof of authorization request.
Status of the proof of authorization request submission.
A constant representing the object's type. For this resource it will always be proof_of_authorization_request_submission.
ID of the proof of authorization request.
Email of the authorizer.
Name of the authorizer.
IP address of the authorizer.
Company of the authorizer.
Terms of authorization.
Time of authorization.
Return the page of entries after this one.
Limit the size of the list that is returned. The default (and maximum) is 100 objects.
ID of the proof of authorization request.
The identifier of the Proof of Authorization Request Submission.
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 event subscription identifier.
The time the event subscription was created.
This indicates if we'll send notifications to this subscription.
If specified, this subscription will only receive webhooks for Events with the specified category.
The webhook url where we'll send notifications.
A constant representing the object's type. For this resource it will always be event_subscription.
The URL you'd like us to send webhooks to.
The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.
If specified, this subscription will only receive webhooks for Events with the specified category.
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 Event Subscription.
The status to update the Event Subscription with.
The identifier of the Event Subscription.
Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. Real time decisions are currently in beta; please contact support@increase.com if you're interested in trying them out!
The Real-Time Decision identifier.
The ISO 8601 date and time at which the Real-Time Decision was created.
The ISO 8601 date and time at which your application can no longer respond to the Real-Time Decision.
The status of the Real-Time Decision.
The category of the Real-Time Decision.
Fields related to a card authorization.
Fields related to a digital wallet token provisioning attempt.
Fields related to a digital wallet authentication attempt.
A constant representing the object's type. For this resource it will always be real_time_decision.
The identifier of the Real-Time Decision.
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 token provisioning attempt, this object contains your response to the attempt.
If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.
The identifier of the Real-Time Decision.
Routing numbers are used to identify your bank in a financial transaction.
The name of the financial institution belonging to a routing number.
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 ACH Transfers.
This routing number's support for Real-Time Payments Transfers.
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 External Account's identifier.
The ISO 8601 date and time at which the External Account was created.
The External Account's description for display purposes.
The External Account's status.
The American Bankers' Association (ABA) Routing Transit Number (RTN).
The destination account number.
The type of the account to which the transfer will be sent.
If you have verified ownership of the External Account.
A constant representing the object's type. For this resource it will always be external_account.
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
The account number for the destination account.
The type of the destination account. Defaults to checking.
The name you choose for the 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.
The external account identifier.
The description you choose to give the external account.
The status of the External Account.
The identifier of the External Account.
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).
The time the File was created.
The File's identifier.
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 description of the File.
Whether the File was generated by Increase or by you and sent to Increase.
The MIME type of the file.
The filename that was provided upon upload or generated by Increase.
A URL from where the File can be downloaded at this point in time. The location of this URL may change over time.
A constant representing the object's type. For this resource it will always be file.
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 file contents. This should follow the specifications of RFC 7578 which defines file transfers for the multipart/form-data protocol.
The description you choose to give the File.
What the File will be used for in Increase's systems.
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.
The identifier of the File.
Increase generates certain documents / forms automatically for your application; they can be listed here. Currently the only supported document type is IRS Form 1099-INT.
The Document identifier.
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.
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.
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.