Increase Simulations API
The Simulations API from Increase — 48 operation(s) for simulations.
Increase Simulations API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Simulations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 48 operations across 48 paths, and defines 91 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.
Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.
48 operations
48 paths
91 schemas
48 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Increase Simulations API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 48
Across 48 paths, the API surfaces 48 operations — 48 POST. Each is listed below with its method, path, parameters, and response codes.
Simulations 48
POST
/simulations/account_revenue_payments
Sandbox: Create an account revenue payment
POST
/simulations/account_statements
Sandbox: Create an Account Statement
POST
/simulations/ach_transfers/{ach_transfer_id}/acknowledge
Sandbox: Acknowledge an ACH Transfer
POST
/simulations/ach_transfers/{ach_transfer_id}/create_notification_of_change
Sandbox: Create a Notification of Change for an ACH Transfer
POST
/simulations/ach_transfers/{ach_transfer_id}/return
Sandbox: Return an ACH Transfer
POST
/simulations/ach_transfers/{ach_transfer_id}/settle
Sandbox: Settle an ACH Transfer
POST
/simulations/ach_transfers/{ach_transfer_id}/submit
Sandbox: Submit an ACH Transfer
POST
/simulations/card_authentications
Sandbox: Create a Card Authentication attempt
POST
/simulations/card_authentications/{card_payment_id}/challenge_attempts
Sandbox: Create a Card Authentication Challenge attempt
POST
/simulations/card_authentications/{card_payment_id}/challenges
Sandbox: Create an initial Card Authentication Challenge
POST
/simulations/card_authorization_expirations
Sandbox: Expire a Card Authorization
POST
/simulations/card_authorizations
Sandbox: Create a Card Authorization
POST
/simulations/card_balance_inquiries
Sandbox: Create a Card Balance Inquiry
POST
/simulations/card_disputes/{card_dispute_id}/action
Sandbox: Advance the state of a Card Dispute
POST
/simulations/card_fuel_confirmations
Sandbox: Confirm the fuel pump amount for a Card Authorization
POST
/simulations/card_increments
Sandbox: Increment a Card Authorization
POST
/simulations/card_purchase_supplements
Sandbox: Create a Card Purchase Supplement
POST
/simulations/card_refunds
Sandbox: Refund a card transaction
POST
/simulations/card_reversals
Sandbox: Reverse a Card Authorization
POST
/simulations/card_settlements
Sandbox: Settle a Card Authorization
POST
/simulations/card_tokens
Sandbox: Create a Card Token
POST
/simulations/check_deposits/{check_deposit_id}/adjustment
Sandbox: Adjust a Check Deposit
POST
/simulations/check_deposits/{check_deposit_id}/reject
Sandbox: Reject a Check Deposit
POST
/simulations/check_deposits/{check_deposit_id}/return
Sandbox: Return a Check Deposit
POST
/simulations/check_deposits/{check_deposit_id}/submit
Sandbox: Submit a Check Deposit
POST
/simulations/check_transfers/{check_transfer_id}/mail
Sandbox: Mail a Check Transfer
POST
/simulations/digital_wallet_token_requests
Sandbox: Create a digital wallet token request
POST
/simulations/entities/{entity_id}/update_validation
Sandbox: Simulate validation of an Entity
POST
/simulations/entity_onboarding_sessions/{entity_onboarding_session_id}/submit
Sandbox: Submit an Entity Onboarding Session
POST
/simulations/exports
Sandbox: Generate a Tax Form Export
POST
/simulations/inbound_ach_transfers
Sandbox: Create an Inbound ACH Transfer
POST
/simulations/inbound_check_deposits
Sandbox: Create an Inbound Check Deposit
POST
/simulations/inbound_check_deposits/{inbound_check_deposit_id}/adjustment
Sandbox: Create an Inbound Check Deposit Adjustment
POST
/simulations/inbound_fednow_transfers
Sandbox: Create an Inbound FedNow Transfer
POST
/simulations/inbound_mail_items
Sandbox: Create an Inbound Mail Item
POST
/simulations/inbound_real_time_payments_transfers
Sandbox: Create an Inbound Real-Time Payments Transfer
POST
/simulations/inbound_wire_drawdown_requests
Sandbox: Create an Inbound Wire Drawdown request
POST
/simulations/inbound_wire_transfers
Sandbox: Create an Inbound Wire Transfer
POST
/simulations/interest_payments
Sandbox: Create an interest payment
POST
/simulations/pending_transactions/{pending_transaction_id}/release_inbound_funds_hold
Sandbox: Release an Inbound Funds Hold
POST
/simulations/physical_cards/{physical_card_id}/advance_shipment
Sandbox: Advance the shipment status of a Physical Card
POST
/simulations/physical_cards/{physical_card_id}/tracking_updates
Sandbox: Create a Physical Card Shipment Tracking Update
POST
/simulations/programs
Sandbox: Create a Program
POST
/simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete
Sandbox: Complete a Real-Time Payments Transfer
POST
/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse
Sandbox: Refuse a Wire Drawdown Request
POST
/simulations/wire_drawdown_requests/{wire_drawdown_request_id}/submit
Sandbox: Submit a Wire Drawdown Request
POST
/simulations/wire_transfers/{wire_transfer_id}/reverse
Sandbox: Reverse a Wire Transfer
POST
/simulations/wire_transfers/{wire_transfer_id}/submit
Sandbox: Submit a Wire Transfer
Schemas 91
The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are card_authentication (39 properties), ach_transfer (36 properties), card_authorization (29 properties), card_financial (28 properties). Each schema is shown below with its type and property counts.
check_deposit
object
Check Deposits allow you to deposit images of paper checks into your account.
19 properties
19 required
card_token
object
Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations.
7 properties
7 required
inbound_card_validation
object
Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid.
22 properties
22 required
card_dispute_file_attachment
object
1 property
1 required
export
object
Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since t…
22 properties
22 required
sandbox_reverse_a_card_authorization_parameters
object
2 properties
1 required
inbound_real_time_payments_transfer
object
An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.
16 properties
16 required
sandbox_create_an_inbound_ach_transfer_parameters
object
12 properties
2 required
card_balance_inquiry
object
Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a cus…
22 properties
22 required
sandbox_create_an_inbound_wire_drawdown_request_parameters
object
19 properties
5 required
inbound_ach_transfer
object
An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.
27 properties
27 required
inbound_ach_transfer_return_intention
object
An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase.
1 property
1 required
sandbox_create_an_inbound_fednow_transfer_parameters
object
6 properties
2 required
check_transfer
object
Check Transfers move funds from your Increase account by mailing a physical check.
25 properties
25 required
physical_card
object
Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile](/documentation/apicard-profiles). The…
9 properties
9 required
sandbox_advance_the_shipment_status_of_a_physical_card_parameters
object
1 property
1 required
sandbox_create_an_inbound_check_deposit_parameters
object
4 properties
3 required
inbound_check_adjustment
object
An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21.
3 properties
3 required
account_statement
object
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 a…
10 properties
10 required
sandbox_create_an_inbound_real_time_payments_transfer_parameters
object
7 properties
2 required
inbound_check_deposit_return_intention
object
An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned.
2 properties
2 required
sandbox_create_a_program_parameters
object
4 properties
1 required
sandbox_create_an_account_statement_parameters
object
1 property
1 required
sandbox_create_a_digital_wallet_token_request_parameters
object
1 property
1 required
card_purchase_supplement
object
Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
6 properties
6 required
sandbox_generate_a_tax_form_export_parameters
object
2 properties
1 required
sandbox_submit_a_check_deposit_parameters
object
1 property
transaction
object
Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn mo…
10 properties
10 required
sandbox_create_a_card_purchase_supplement_parameters
object
3 properties
1 required
pending_transaction
object
Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current bala…
13 properties
13 required
card_financial
object
Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction.
28 properties
28 required
card_dispute
object
If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.
14 properties
14 required
sandbox_complete_a_real_time_payments_transfer_parameters
object
1 property
program
object
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 l…
10 properties
10 required
check_transfer_deposit
object
An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered.
8 properties
8 required
card_dispute_visa_network_event
object
17 properties
4 required
sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization_parameters
object
2 properties
2 required
inbound_card_authorization_simulation_result
object
The results of a Card Authorization simulation.
3 properties
3 required
sandbox_create_a_card_authentication_attempt_parameters
object
8 properties
1 required
sandbox_create_an_account_revenue_payment_parameters
object
5 properties
2 required
error
sandbox_create_a_notification_of_change_for_an_ach_transfer_parameters
object
2 properties
2 required
inbound_funds_hold
object
We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.
9 properties
9 required
sandbox_create_a_physical_card_shipment_tracking_update_parameters
object
5 properties
1 required
entity_onboarding_session
object
Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the return…
10 properties
10 required
sandbox_adjust_a_check_deposit_parameters
object
2 properties
sandbox_settle_a_card_authorization_parameters
object
3 properties
2 required
wire_transfer
object
Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
25 properties
25 required
inbound_check_deposit
object
Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.
20 properties
20 required
card_dispute_visa_user_submission
object
13 properties
10 required
sandbox_create_a_card_authorization_parameters
object
17 properties
1 required
sandbox_expire_a_card_authorization_parameters
object
1 property
1 required
card_settlement
object
Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly…
24 properties
24 required
ach_decline
object
12 properties
12 required
sandbox_settle_an_ach_transfer_parameters
object
1 property
sandbox_create_a_card_token_parameters
object
6 properties
check_transfer_stop_payment_request
object
A Check Transfer Stop Payment Request is created when a check transfer is stopped. It offsets the Check Transfer Intention.
4 properties
4 required
inbound_digital_wallet_token_request_simulation_result
object
The results of a Digital Wallet Token simulation.
3 properties
3 required
sandbox_create_a_card_authentication_challenge_attempt_parameters
object
1 property
1 required
entity_supplemental_document
object
Supplemental Documents are uploaded files connected to an Entity during onboarding.
5 properties
5 required
sandbox_refund_a_card_transaction_parameters
object
3 properties
entity
object
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entit…
19 properties
19 required
card_payment
object
Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
9 properties
9 required
card_authentication
object
Card Authentications are attempts to authenticate a transaction or a card with 3DS.
39 properties
39 required
card_dispute_financial_visa
object
1 property
1 required
card_authorization
object
Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction.
29 properties
29 required
sandbox_create_an_interest_payment_parameters
object
5 properties
2 required
card_fuel_confirmation
object
Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed.
9 properties
9 required
sandbox_increment_a_card_authorization_parameters
object
3 properties
2 required
card_dispute_visa
object
3 properties
3 required
inbound_mail_item
object
Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.
10 properties
10 required
card_reversal
object
Card Reversals cancel parts of or the entirety of an existing Card Authorization.
22 properties
22 required
wire_drawdown_request
object
Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these…
18 properties
18 required
sandbox_return_an_ach_transfer_parameters
object
1 property
inbound_mail_item_check
object
Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
5 properties
5 required
inbound_wire_transfer_reversal
object
An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed.
1 property
1 required
sandbox_simulate_validation_of_an_entity_parameters
object
1 property
1 required
inbound_wire_drawdown_request
object
Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation](/docume…
21 properties
21 required
declined_transaction
object
Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has a…
10 properties
10 required
card_increment
object
Card Increments increase the pending amount of an authorized transaction.
16 properties
16 required
sandbox_create_an_inbound_wire_transfer_parameters
object
16 properties
2 required
sandbox_advance_the_state_of_a_card_dispute_parameters
object
2 properties
1 required
sandbox_create_a_card_balance_inquiry_parameters
object
15 properties
card_authorization_expiration
object
Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer.
6 properties
6 required
inbound_fednow_transfer
object
An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account.
16 properties
16 required
sandbox_create_an_inbound_check_deposit_adjustment_parameters
object
2 properties
card_refund
object
Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card wit…
20 properties
20 required
ach_transfer
object
ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
36 properties
36 required
sandbox_create_an_inbound_mail_item_parameters
object
4 properties
1 required
real_time_payments_transfer
object
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
25 properties
25 required
inbound_wire_transfer
object
An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.
25 properties
25 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Increase 12
Other APIs Increase publishes across the network.
Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Payments API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API
#Simulations