Increase

Increase API

Increase API endpoints from Increase

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Increase API endpoints from Increase

Endpoints 115

  • GETList Account Numbers/account_numbers?cursor=string&limit=0&status=active&account_id=string
  • POSTCreate an Account Number/account_numbers
  • GETRetrieve an Account Number/account_numbers/:account_number_id
  • PATCHUpdate an Account Number/account_numbers/:account_number_id
  • GETList Account Statements/account_statements?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&statement_period_start.after=2024-01-01T00:00:00Z&statement_period_start.before=2024-01-01T00:00:00Z&statement_period_start.on_or_after=2024-01-01T00:00:00Z&statement_period_start.on_or_before=2024-01-01T00:00:00Z
  • GETRetrieve an Account Statement/account_statements/:account_statement_id
  • GETList Account Transfers/account_transfers?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate an Account Transfer/account_transfers
  • GETRetrieve an Account Transfer/account_transfers/:account_transfer_id
  • POSTApprove an Account Transfer/account_transfers/:account_transfer_id/approve
  • POSTCancel an Account Transfer/account_transfers/:account_transfer_id/cancel
  • GETList Accounts/accounts?cursor=string&limit=0&entity_id=entity_n8y8tnk2p9339ti393yi&status=open
  • POSTCreate an Account/accounts
  • GETRetrieve an Account/accounts/:account_id
  • PATCHUpdate an Account/accounts/:account_id
  • POSTClose an Account/accounts/:account_id/close
  • GETList ACH Prenotifications/ach_prenotifications?cursor=string&limit=0&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate an ACH Prenotification/ach_prenotifications
  • GETRetrieve an ACH Prenotification/ach_prenotifications/:ach_prenotification_id
  • GETList ACH Transfers/ach_transfers?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&external_account_id=string&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate an ACH Transfer/ach_transfers
  • GETRetrieve an ACH Transfer/ach_transfers/:ach_transfer_id
  • POSTApprove an ACH Transfer/ach_transfers/:ach_transfer_id/approveApproves an ACH Transfer in a pending_approval state.
  • POSTCancel a pending ACH Transfer/ach_transfers/:ach_transfer_id/cancelCancels an ACH Transfer in a pending_approval state.
  • GETList Card Disputes/card_disputes?cursor=string&limit=0&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z&status.in=pending_reviewing
  • POSTCreate a Card Dispute/card_disputes
  • GETRetrieve a Card Dispute/card_disputes/:card_dispute_id
  • GETList Card Profiles/card_profiles?cursor=string&limit=0&status.in=pending
  • POSTCreate a Card Profile/card_profiles
  • GETRetrieve a Card Profile/card_profiles/:card_profile_id
  • GETList Cards/cards?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate a Card/cards
  • GETRetrieve a Card/cards/:card_id
  • PATCHUpdate a Card/cards/:card_id
  • GETRetrieve sensitive details for a Card/cards/:card_id/details
  • GETList Check Deposits/check_deposits?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate a Check Deposit/check_deposits
  • GETRetrieve a Check Deposit/check_deposits/:check_deposit_id
  • GETList Check Transfers/check_transfers?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate a Check Transfer/check_transfers
  • GETRetrieve a Check Transfer/check_transfers/:check_transfer_id
  • POSTApprove a Check Transfer/check_transfers/:check_transfer_id/approve
  • POSTCancel a pending Check Transfer/check_transfers/:check_transfer_id/cancel
  • POSTRequest a stop payment on a Check Transfer/check_transfers/:check_transfer_id/stop_payment
  • GETList Declined Transactions/declined_transactions?cursor=string&limit=0&account_id=string&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z&route_id=string
  • GETRetrieve a Declined Transaction/declined_transactions/:declined_transaction_id
  • GETList Digital Wallet Tokens/digital_wallet_tokens?cursor=string&limit=0&card_id=card_oubs0hwk5rn6knuecxg2&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • GETRetrieve a Digital Wallet Token/digital_wallet_tokens/:digital_wallet_token_id
  • GETList Documents/documents?cursor=string&limit=0&entity_id=string&category.in=form_1099_int&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • GETRetrieve a Document/documents/:document_id
  • GETList Entities/entities?cursor=string&limit=0
  • POSTCreate an Entity/entities
  • GETRetrieve an Entity/entities/:entity_id
  • POSTCreate a supplemental document for an Entity/entities/:entity_id/supplemental_documents
  • GETList Event Subscriptions/event_subscriptions?cursor=string&limit=0
  • POSTCreate an Event Subscription/event_subscriptions
  • GETRetrieve an Event Subscription/event_subscriptions/:event_subscription_id
  • PATCHUpdate an Event Subscription/event_subscriptions/:event_subscription_id
  • GETList Events/events?cursor=string&limit=0&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z&category.in=account.created&associated_object_id=string
  • GETRetrieve an Event/events/:event_id
  • GETList External Accounts/external_accounts?cursor=string&limit=0&status.in=active
  • POSTCreate an External Account/external_accounts
  • GETRetrieve an External Account/external_accounts/:external_account_id
  • PATCHUpdate an External Account/external_accounts/:external_account_id
  • GETList Files/files?cursor=string&limit=0&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z&purpose.in=check_image_front
  • POSTCreate a File/filesTo 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,…
  • GETRetrieve a File/files/:file_id
  • GETRetrieve Group details/groups/currentReturns details for the currently authenticated Group.
  • GETList Inbound ACH Transfer Returns/inbound_ach_transfer_returns?cursor=string&limit=0
  • POSTCreate an ACH Return/inbound_ach_transfer_returns
  • GETRetrieve an Inbound ACH Transfer Return/inbound_ach_transfer_returns/:inbound_ach_transfer_return_id
  • GETList Inbound Wire Drawdown Requests/inbound_wire_drawdown_requests?cursor=string&limit=0
  • GETRetrieve an Inbound Wire Drawdown Request/inbound_wire_drawdown_requests/:inbound_wire_drawdown_request_id
  • GETList Limits/limits?cursor=string&limit=0&model_id=account_number_v18nkfqm6afpsrvy82b2&status=active
  • POSTCreate a Limit/limits
  • GETRetrieve a Limit/limits/:limit_id
  • PATCHUpdate a Limit/limits/:limit_id
  • GETList OAuth Connections/oauth_connections?cursor=string&limit=0
  • GETRetrieve an OAuth Connection/oauth_connections/:oauth_connection_id
  • GETList Pending Transactions/pending_transactions?cursor=string&limit=0&account_id=string&route_id=string&source_id=string&status.in=pending
  • GETRetrieve a Pending Transaction/pending_transactions/:pending_transaction_id
  • GETRetrieve a Real-Time Decision/real_time_decisions/:real_time_decision_id
  • POSTAction a Real-Time Decision/real_time_decisions/:real_time_decision_id/action
  • GETList Routing Numbers/routing_numbers?cursor=string&limit=0&routing_number=021000021You 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…
  • POSTSimulate an Account Statement being created/simulations/account_statementsSimulates an Account Statement being created for an account. In production, Account Statements are generated once per month.
  • POSTComplete a Sandbox Account Transfer/simulations/account_transfers/:account_transfer_id/completeIf your account is configured to require approval for each transfer, this endpoint simulates the approval of an Account Transfer. You can also approve sandbox…
  • POSTReturn a Sandbox ACH Transfer/simulations/ach_transfers/:ach_transfer_id/returnSimulates 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…
  • POSTSubmit a Sandbox ACH Transfer/simulations/ach_transfers/:ach_transfer_id/submitSimulates the submission of an ACH Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_submission. In…
  • POSTSimulate an authorization on a Card/simulations/card_authorizationsSimulates a purchase authorization on a Card. Depending on the balance available to the card and the amount submitted, the authorization activity will result…
  • POSTSimulates advancing the state of a card dispute/simulations/card_disputes/:card_dispute_id/actionAfter 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…
  • POSTSimulate a refund on a card/simulations/card_refundsSimulates refunding a card transaction. The full value of the original sandbox transaction is refunded.
  • POSTSimulate settling a card authorization/simulations/card_settlementsSimulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This…
  • POSTReject a Sandbox Check Deposit/simulations/check_deposits/:check_deposit_id/rejectSimulates 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.
  • POSTReturn a Sandbox Check Deposit/simulations/check_deposits/:check_deposit_id/returnSimulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.
  • POSTSubmit a Sandbox Check Deposit/simulations/check_deposits/:check_deposit_id/submitSimulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.
  • POSTDeposit a Sandbox Check Transfer/simulations/check_transfers/:check_transfer_id/depositSimulates a Check Transfer being deposited at a bank. This transfer must first have a status of mailed.
  • POSTMail a Sandbox Check Transfer/simulations/check_transfers/:check_transfer_id/mailSimulates the mailing of a Check Transfer, which happens once per weekday in production but can be sped up in sandbox. This transfer must first have a status…
  • POSTSimulate digital wallet provisioning for a card/simulations/digital_wallet_token_requestsSimulates a user attempting add a Card to a digital wallet such as Apple Pay.
  • POSTSimulate a tax document being created/simulations/documentsSimulates an tax document being created for an account.
  • POSTSimulate an ACH Transfer to your account/simulations/inbound_ach_transfersSimulates an inbound ACH transfer to your account. This imitates initiating a transaction to an Increase account from a different financial institution. The…
  • POSTSimulate a Real Time Payments Transfer to your account/simulations/inbound_real_time_payments_transfersSimulates an inbound Real Time Payments transfer to your account. Real Time Payments are a beta feature.
  • POSTSimulate an Inbound Wire Drawdown request being created/simulations/inbound_wire_drawdown_requestsSimulates the receival of an Inbound Wire Drawdown Request.
  • POSTSimulate a Wire Transfer to your account/simulations/inbound_wire_transfersSimulates an inbound Wire Transfer to your account.
  • POSTReverse a Sandbox Wire Transfer/simulations/wire_transfers/:wire_transfer_id/reverseSimulates 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…
  • POSTSubmit a Sandbox Wire Transfer/simulations/wire_transfers/:wire_transfer_id/submitSimulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_creating.
  • GETList Transactions/transactions?cursor=string&limit=0&account_id=string&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z&category.in=account_transfer_intention&route_id=string
  • GETRetrieve a Transaction/transactions/:transaction_id
  • GETList Wire Drawdown Requests/wire_drawdown_requests?cursor=string&limit=0
  • POSTCreate a Wire Drawdown Request/wire_drawdown_requests
  • GETRetrieve a Wire Drawdown Request/wire_drawdown_requests/:wire_drawdown_request_id
  • GETList Wire Transfers/wire_transfers?cursor=string&limit=0&account_id=account_in71c4amph0vgo2qllky&external_account_id=string&created_at.after=2024-01-01T00:00:00Z&created_at.before=2024-01-01T00:00:00Z&created_at.on_or_after=2024-01-01T00:00:00Z&created_at.on_or_before=2024-01-01T00:00:00Z
  • POSTCreate a Wire Transfer/wire_transfers
  • GETRetrieve a Wire Transfer/wire_transfers/:wire_transfer_id
  • POSTApprove a Wire Transfer/wire_transfers/:wire_transfer_id/approve
  • POSTCancel a pending Wire Transfer/wire_transfers/:wire_transfer_id/cancel

API details

Base URL
https://api.increase.com
https://sandbox.increase.com
Authentication
A bearer token in the Authorization header
Operations
115 operations on 91 pathsGET 58POST 51PATCH 6
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 0.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Increase API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Increase API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List Account Numbers” (GET /account_numbers?cursor=string&limit=0&status=active&account_id=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Increase API?

Increase API endpoints from Increase It is listed under Other and has 115 endpoints.

Who publishes the Increase API?

It is listed from Increase's public API description (an OpenAPI document), not published by Increase on Swastik Codes. Anyone who controls increase.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Increase API?

Its description lists 2 base URLs: https://api.increase.com, https://sandbox.increase.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Increase API?

With A bearer token in the Authorization header.

How many endpoints does the Increase API have?

115 operations on 91 paths (58 GET, 51 POST, 6 PATCH).

Is forking the Increase API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.