Increase API

Tools (117)

Extracted live via the executor SDK.

• accountNumbers.createAnAccountNumber

  Create an Account Number

• accountNumbers.listAccountNumbers

  List Account Numbers

• accountNumbers.retrieveAnAccountNumber

  Retrieve an Account Number

• accountNumbers.updateAnAccountNumber

  Update an Account Number

• accounts.closeAnAccount

  Close an Account

• accounts.createAnAccount

  Create an Account

• accounts.listAccounts

  List Accounts

• accounts.retrieveAnAccount

  Retrieve an Account

• accounts.updateAnAccount

  Update an Account

• accountStatements.listAccountStatements

  List Account Statements

• accountStatements.retrieveAnAccountStatement

  Retrieve an Account Statement

• accountTransfers.approveAnAccountTransfer

  Approve an Account Transfer

• accountTransfers.cancelAnAccountTransfer

  Cancel an Account Transfer

• accountTransfers.createAnAccountTransfer

  Create an Account Transfer

• accountTransfers.listAccountTransfers

  List Account Transfers

• accountTransfers.retrieveAnAccountTransfer

  Retrieve an Account Transfer

• achPrenotifications.createAnAchPrenotification

  Create an ACH Prenotification

• achPrenotifications.listAchPrenotifications

  List ACH Prenotifications

• achPrenotifications.retrieveAnAchPrenotification

  Retrieve an ACH Prenotification

• achTransfers.approveAnAchTransfer

  Approves an ACH Transfer in a pending_approval state.

• achTransfers.cancelAPendingAchTransfer

  Cancels an ACH Transfer in a pending_approval state.

• achTransfers.createAnAchTransfer

  Create an ACH Transfer

• achTransfers.listAchTransfers

  List ACH Transfers

• achTransfers.retrieveAnAchTransfer

  Retrieve an ACH Transfer

• cardDisputes.createACardDispute

  Create a Card Dispute

• cardDisputes.listCardDisputes

  List Card Disputes

• cardDisputes.retrieveACardDispute

  Retrieve a Card Dispute

• cardProfiles.createACardProfile

  Create a Card Profile

• cardProfiles.listCardProfiles

  List Card Profiles

• cardProfiles.retrieveACardProfile

  Retrieve a Card Profile

• cards.createACard

  Create a Card

• cards.listCards

  List Cards

• cards.retrieveACard

  Retrieve a Card

• cards.retrieveSensitiveDetailsForACard

  Retrieve sensitive details for a Card

• cards.updateACard

  Update a Card

• checkDeposits.createACheckDeposit

  Create a Check Deposit

• checkDeposits.listCheckDeposits

  List Check Deposits

• checkDeposits.retrieveACheckDeposit

  Retrieve a Check Deposit

• checkTransfers.approveACheckTransfer

  Approve a Check Transfer

• checkTransfers.cancelAPendingCheckTransfer

  Cancel a pending Check Transfer

• checkTransfers.createACheckTransfer

  Create a Check Transfer

• checkTransfers.listCheckTransfers

  List Check Transfers

• checkTransfers.requestAStopPaymentOnACheckTransfer

  Request a stop payment on a Check Transfer

• checkTransfers.retrieveACheckTransfer

  Retrieve a Check Transfer

• declinedTransactions.listDeclinedTransactions

  List Declined Transactions

• declinedTransactions.retrieveADeclinedTransaction

  Retrieve a Declined Transaction

• digitalWalletTokens.listDigitalWalletTokens

  List Digital Wallet Tokens

• digitalWalletTokens.retrieveADigitalWalletToken

  Retrieve a Digital Wallet Token

• documents.listDocuments

  List Documents

• documents.retrieveADocument

  Retrieve a Document

• entities.createAnEntity

  Create an Entity

• entities.createASupplementalDocumentForAnEntity

  Create a supplemental document for an Entity

• entities.listEntities

  List Entities

• entities.retrieveAnEntity

  Retrieve an Entity

• events.listEvents

  List Events

• events.retrieveAnEvent

  Retrieve an Event

• eventSubscriptions.createAnEventSubscription

  Create an Event Subscription

• eventSubscriptions.listEventSubscriptions

  List Event Subscriptions

• eventSubscriptions.retrieveAnEventSubscription

  Retrieve an Event Subscription

• eventSubscriptions.updateAnEventSubscription

  Update an Event Subscription

• externalAccounts.createAnExternalAccount

  Create an External Account

• externalAccounts.listExternalAccounts

  List External Accounts

• externalAccounts.retrieveAnExternalAccount

  Retrieve an External Account

• externalAccounts.updateAnExternalAccount

  Update an External Account

• files.createAFile

  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.

• files.listFiles

  List Files

• files.retrieveAFile

  Retrieve a File

• groups.retrieveGroupDetails

  Returns details for the currently authenticated Group.

• inboundAchTransferReturns.createAnAchReturn

  Create an ACH Return

• inboundAchTransferReturns.listInboundAchTransferReturns

  List Inbound ACH Transfer Returns

• inboundAchTransferReturns.retrieveAnInboundAchTransferReturn

  Retrieve an Inbound ACH Transfer Return

• inboundWireDrawdownRequests.listInboundWireDrawdownRequests

  List Inbound Wire Drawdown Requests

• inboundWireDrawdownRequests.retrieveAnInboundWireDrawdownRequest

  Retrieve an Inbound Wire Drawdown Request

• limits.createALimit

  Create a Limit

• limits.listLimits

  List Limits

• limits.retrieveALimit

  Retrieve a Limit

• limits.updateALimit

  Update a Limit

• oauthConnections.listOauthConnections

  List OAuth Connections

• oauthConnections.retrieveAnOauthConnection

  Retrieve an OAuth Connection

• pendingTransactions.listPendingTransactions

  List Pending Transactions

• pendingTransactions.retrieveAPendingTransaction

  Retrieve a Pending Transaction

• realTimeDecisions.actionARealTimeDecision

  Action a Real-Time Decision

• realTimeDecisions.retrieveARealTimeDecision

  Retrieve a Real-Time Decision

• routingNumbers.listRoutingNumbers

  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.

• simulations.completeASandboxAccountTransfer

  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.

• simulations.depositASandboxCheckTransfer

  Simulates a Check Transfer being deposited at a bank. This transfer must first have a status of mailed.

• simulations.mailASandboxCheckTransfer

  Simulates 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 of pending_approval or pending_submission.

• simulations.rejectASandboxCheckDeposit

  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.

• simulations.returnASandboxAchTransfer

  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.

• simulations.returnASandboxCheckDeposit

  Simulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.

• simulations.reverseASandboxWireTransfer

  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.'

• simulations.simulateAnAccountStatementBeingCreated

  Simulates an Account Statement being created for an account. In production, Account Statements are generated once per month.

• simulations.simulateAnAchTransferToYourAccount

  Simulates an inbound ACH transfer to your account. This imitates initiating a transaction 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 be either a Transaction or a Declined Transaction depending on whether or not the transfer is allowed.

• simulations.simulateAnAuthorizationOnACard

  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.

• simulations.simulateAnInboundWireDrawdownRequestBeingCreated

  Simulates the receival of an Inbound Wire Drawdown Request.

• simulations.simulateARealTimePaymentsTransferToYourAccount

  Simulates an inbound Real Time Payments transfer to your account. Real Time Payments are a beta feature.

• simulations.simulateARefundOnACard

  Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.

• simulations.simulateATaxDocumentBeingCreated

  Simulates an tax document being created for an account.

• simulations.simulateAWireTransferToYourAccount

  Simulates an inbound Wire Transfer to your account.

• simulations.simulateDigitalWalletProvisioningForACard

  Simulates a user attempting add a Card to a digital wallet such as Apple Pay.

• simulations.simulatesAdvancingTheStateOfACardDispute

  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.

• simulations.simulateSettlingACardAuthorization

  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.

• simulations.submitASandboxAchTransfer

  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.

• simulations.submitASandboxCheckDeposit

  Simulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.

• simulations.submitASandboxWireTransfer

  Simulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_creating.

• transactions.listTransactions

  List Transactions

• transactions.retrieveATransaction

  Retrieve a Transaction

• wireDrawdownRequests.createAWireDrawdownRequest

  Create a Wire Drawdown Request

• wireDrawdownRequests.listWireDrawdownRequests

  List Wire Drawdown Requests

• wireDrawdownRequests.retrieveAWireDrawdownRequest

  Retrieve a Wire Drawdown Request

• wireTransfers.approveAWireTransfer

  Approve a Wire Transfer

• wireTransfers.cancelAPendingWireTransfer

  Cancel a pending Wire Transfer

• wireTransfers.createAWireTransfer

  Create a Wire Transfer

• wireTransfers.listWireTransfers

  List Wire Transfers

• wireTransfers.retrieveAWireTransfer

  Retrieve a Wire Transfer

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools