Increase

Increase Simulations API

The Simulations API from Increase — 48 operation(s) for simulations.

GitHub OpenAPI

Operations 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 #

Documentation

📖
Documentation
https://increase.com/documentation/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-simulations-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/increase-simulations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

increase-simulations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
  title: Increase Simulations API
  version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- name: Simulations
paths:
  /simulations/account_revenue_payments:
    post:
      description: Simulates an account revenue payment to your account. In production, this happens automatically on the first of each month.
      operationId: sandbox_create_an_account_revenue_payment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_an_account_revenue_payment_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transaction'
          description: Transaction
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create an account revenue payment'
      x-returns-example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 100
        created_at: '2020-01-31T23:59:59Z'
        currency: USD
        description: Revenue Payment for My first account! in 2025-06
        id: transaction_uyrp7fld2ium70oa7oi
        route_id: null
        route_type: null
        source:
          account_revenue_payment:
            accrued_on_account_id: account_in71c4amph0vgo2qllky
            period_end: '2025-06-30T23:59:59+00:00'
            period_start: '2025-06-01T00:00:00+00:00'
          category: account_revenue_payment
        type: transaction
      x-sandbox-only: true
      x-tag: Accounts
      tags:
      - Simulations
  /simulations/account_statements:
    post:
      description: Simulates an [Account Statement](#account-statements) being created for an account. In production, Account Statements are generated once per month.
      operationId: sandbox_create_an_account_statement
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_an_account_statement_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_statement'
          description: Account Statement
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create an Account Statement'
      x-sandbox-only: true
      x-tag: Account Statements
      tags:
      - Simulations
  /simulations/ach_transfers/{ach_transfer_id}/acknowledge:
    post:
      description: Simulates the acknowledgement of an [ACH Transfer](#ach-transfers) by the Federal Reserve. This transfer must first have a `status` of `submitted`. In production, the Federal Reserve generally acknowledges submitted ACH files within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and add the acknowledgement subresource to the ACH Transfer.
      operationId: sandbox_acknowledge_an_ach_transfer
      parameters:
      - example: ach_transfer_uoxatyh3lt5evrsdvo7q
        in: path
        name: ach_transfer_id
        required: true
        schema:
          description: The identifier of the ACH Transfer you wish to become acknowledged.
          type: string
          x-documentation-priority: default
          x-id-reference-to: ACH Transfers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ach_transfer'
          description: ACH Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Acknowledge an ACH Transfer'
      x-sandbox-only: true
      x-tag: ACH Transfers
      tags:
      - Simulations
  /simulations/ach_transfers/{ach_transfer_id}/create_notification_of_change:
    post:
      description: Simulates receiving a Notification of Change for an [ACH Transfer](#ach-transfers).
      operationId: sandbox_create_a_notification_of_change_for_an_ach_transfer
      parameters:
      - example: ach_transfer_uoxatyh3lt5evrsdvo7q
        in: path
        name: ach_transfer_id
        required: true
        schema:
          description: The identifier of the ACH Transfer you wish to create a notification of change for.
          type: string
          x-documentation-priority: default
          x-id-reference-to: ACH Transfers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_notification_of_change_for_an_ach_transfer_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ach_transfer'
          description: ACH Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Notification of Change for an ACH Transfer'
      x-sandbox-only: true
      x-tag: ACH Transfers
      tags:
      - Simulations
  /simulations/ach_transfers/{ach_transfer_id}/return:
    post:
      description: Simulates the return of an [ACH Transfer](#ach-transfers) 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`.
      operationId: sandbox_return_an_ach_transfer
      parameters:
      - example: ach_transfer_uoxatyh3lt5evrsdvo7q
        in: path
        name: ach_transfer_id
        required: true
        schema:
          description: The identifier of the ACH Transfer you wish to return.
          type: string
          x-documentation-priority: default
          x-id-reference-to: ACH Transfers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_return_an_ach_transfer_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ach_transfer'
          description: ACH Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Return an ACH Transfer'
      x-sandbox-only: true
      x-tag: ACH Transfers
      tags:
      - Simulations
  /simulations/ach_transfers/{ach_transfer_id}/settle:
    post:
      description: 'Simulates the settlement of an [ACH Transfer](#ach-transfers) by the Federal Reserve. This transfer must first have a `status` of `pending_submission` or `submitted`. For convenience, if the transfer is in `status`: `pending_submission`, the simulation will also submit the transfer. Without this simulation the transfer will eventually settle on its own following the same Federal Reserve timeline as in production. Additionally, you can specify the behavior of the inbound funds hold that is created when the ACH Transfer is settled. If no behavior is specified, the inbound funds hold will be released immediately in order for the funds to be available for use.'
      operationId: sandbox_settle_an_ach_transfer
      parameters:
      - example: ach_transfer_uoxatyh3lt5evrsdvo7q
        in: path
        name: ach_transfer_id
        required: true
        schema:
          description: The identifier of the ACH Transfer you wish to become settled.
          type: string
          x-documentation-priority: default
          x-id-reference-to: ACH Transfers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_settle_an_ach_transfer_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ach_transfer'
          description: ACH Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Settle an ACH Transfer'
      x-sandbox-only: true
      x-tag: ACH Transfers
      tags:
      - Simulations
  /simulations/ach_transfers/{ach_transfer_id}/submit:
    post:
      description: Simulates the submission of an [ACH Transfer](#ach-transfers) 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`.
      operationId: sandbox_submit_an_ach_transfer
      parameters:
      - example: ach_transfer_uoxatyh3lt5evrsdvo7q
        in: path
        name: ach_transfer_id
        required: true
        schema:
          description: The identifier of the ACH Transfer you wish to submit.
          type: string
          x-documentation-priority: default
          x-id-reference-to: ACH Transfers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ach_transfer'
          description: ACH Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Submit an ACH Transfer'
      x-sandbox-only: true
      x-tag: ACH Transfers
      tags:
      - Simulations
  /simulations/card_authentications:
    post:
      description: Simulates a Card Authentication attempt on a [Card](#cards). The attempt always results in a [Card Payment](#card_payments) being created, either with a status that allows further action or a terminal failed status.
      operationId: sandbox_create_a_card_authentication_attempt
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_card_authentication_attempt_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Card Authentication attempt'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_authentications/{card_payment_id}/challenge_attempts:
    post:
      description: Simulates an attempt at a Card Authentication Challenge. This updates the `card_authentications` object under the [Card Payment](#card_payments). You can also attempt the challenge by navigating to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
      operationId: sandbox_create_a_card_authentication_challenge_attempt
      parameters:
      - example: card_payment_nd3k2kacrqjli8482ave
        in: path
        name: card_payment_id
        required: true
        schema:
          description: The identifier of the Card Payment to be challenged.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Card Payments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_card_authentication_challenge_attempt_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Card Authentication Challenge attempt'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_authentications/{card_payment_id}/challenges:
    post:
      description: Simulates starting a Card Authentication Challenge for an existing Card Authentication. This updates the `card_authentications` object under the [Card Payment](#card_payments). To attempt the challenge, use the `/simulations/card_authentications/:card_payment_id/challenge_attempts` endpoint or navigate to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id.
      operationId: sandbox_create_an_initial_card_authentication_challenge
      parameters:
      - example: card_payment_nd3k2kacrqjli8482ave
        in: path
        name: card_payment_id
        required: true
        schema:
          description: The identifier of the Card Payment to be challenged.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Card Payments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create an initial Card Authentication Challenge'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_authorization_expirations:
    post:
      description: Simulates expiring a Card Authorization immediately.
      operationId: sandbox_expire_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_expire_a_card_authorization_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Expire a Card Authorization'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_authorizations:
    post:
      description: Simulates a purchase authorization on a [Card](#cards). Depending on the balance available to the card and the `amount` submitted, the authorization activity will result in a [Pending Transaction](#pending-transactions) of type `card_authorization` or a [Declined Transaction](#declined-transactions) of type `card_decline`. You can pass either a Card id or a [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different ways purchases can be made.
      operationId: sandbox_create_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_card_authorization_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inbound_card_authorization_simulation_result'
          description: Inbound Card Authorization Simulation Result
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Card Authorization'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_balance_inquiries:
    post:
      description: Simulates a balance inquiry on a [Card](#cards).
      operationId: sandbox_create_a_card_balance_inquiry
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_card_balance_inquiry_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Card Balance Inquiry'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_disputes/{card_dispute_id}/action:
    post:
      description: After a [Card Dispute](#card-disputes) is created in production, the dispute will initially be in a `pending_user_submission_reviewing` state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states.
      operationId: sandbox_advance_the_state_of_a_card_dispute
      parameters:
      - example: card_dispute_h9sc95nbl1cgltpp7men
        in: path
        name: card_dispute_id
        required: true
        schema:
          description: The dispute you would like to action.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Card Disputes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_advance_the_state_of_a_card_dispute_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_dispute'
          description: Card Dispute
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Advance the state of a Card Dispute'
      x-sandbox-only: true
      x-tag: Card Disputes
      tags:
      - Simulations
  /simulations/card_fuel_confirmations:
    post:
      description: Simulates the fuel confirmation of an authorization by a card acquirer. This happens asynchronously right after a fuel pump transaction is completed. A fuel confirmation can only happen once per authorization.
      operationId: sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Confirm the fuel pump amount for a Card Authorization'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_increments:
    post:
      description: Simulates the increment of an authorization by a card acquirer. An authorization can be incremented multiple times.
      operationId: sandbox_increment_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_increment_a_card_authorization_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Increment a Card Authorization'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_purchase_supplements:
    post:
      description: Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card settlement. This happens asynchronously in production when Visa sends enhanced transaction data about a purchase.
      operationId: sandbox_create_a_card_purchase_supplement
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_card_purchase_supplement_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_purchase_supplement'
          description: Card Purchase Supplement
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Card Purchase Supplement'
      x-sandbox-only: true
      x-tag: Card Purchase Supplements
      tags:
      - Simulations
  /simulations/card_refunds:
    post:
      description: Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.
      operationId: sandbox_refund_a_card_transaction
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_refund_a_card_transaction_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transaction'
          description: Transaction
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Refund a card transaction'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_reversals:
    post:
      description: Simulates the reversal of an authorization by a card acquirer. An authorization can be partially reversed multiple times, up until the total authorized amount. Marks the pending transaction as complete if the authorization is fully reversed.
      operationId: sandbox_reverse_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_reverse_a_card_authorization_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Reverse a Card Authorization'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_settlements:
    post:
      description: 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.
      operationId: sandbox_settle_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_settle_a_card_authorization_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transaction'
          description: Transaction
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Settle a Card Authorization'
      x-sandbox-only: true
      x-tag: Card Payments
      tags:
      - Simulations
  /simulations/card_tokens:
    post:
      description: Simulates tokenizing a card in the sandbox environment.
      operationId: sandbox_create_a_card_token
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_card_token_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_token'
          description: Card Token
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Create a Card Token'
      x-sandbox-only: true
      x-tag: Card Tokens
      tags:
      - Simulations
  /simulations/check_deposits/{check_deposit_id}/adjustment:
    post:
      description: Simulates the creation of a [Check Deposit Adjustment](#check-deposit-adjustments) on a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`.
      operationId: sandbox_adjust_a_check_deposit
      parameters:
      - example: check_deposit_f06n9gpg7sxn8t19lfc1
        in: path
        name: check_deposit_id
        required: true
        schema:
          description: The identifier of the Check Deposit you wish to adjust.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Check Deposits
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_adjust_a_check_deposit_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_deposit'
          description: Check Deposit
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Adjust a Check Deposit'
      x-sandbox-only: true
      x-tag: Check Deposits
      tags:
      - Simulations
  /simulations/check_deposits/{check_deposit_id}/reject:
    post:
      description: Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to factors like poor image quality. This Check Deposit must first have a `status` of `pending`.
      operationId: sandbox_reject_a_check_deposit
      parameters:
      - example: check_deposit_f06n9gpg7sxn8t19lfc1
        in: path
        name: check_deposit_id
        required: true
        schema:
          description: The identifier of the Check Deposit you wish to reject.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Check Deposits
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_deposit'
          description: Check Deposit
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Reject a Check Deposit'
      x-sandbox-only: true
      x-tag: Check Deposits
      tags:
      - Simulations
  /simulations/check_deposits/{check_deposit_id}/return:
    post:
      description: Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`.
      operationId: sandbox_return_a_check_deposit
      parameters:
      - example: check_deposit_f06n9gpg7sxn8t19lfc1
        in: path
        name: check_deposit_id
        required: true
        schema:
          description: The identifier of the Check Deposit you wish to return.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Check Deposits
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_deposit'
          description: Check Deposit
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Return a Check Deposit'
      x-sandbox-only: true
      x-tag: Check Deposits
      tags:
      - Simulations
  /simulations/check_deposits/{check_deposit_id}/submit:
    post:
      description: Simulates the submission of a [Check Deposit](#check-deposits) to the Federal Reserve. This Check Deposit must first have a `status` of `pending`.
      operationId: sandbox_submit_a_check_deposit
      parameters:
      - example: check_deposit_f06n9gpg7sxn8t19lfc1
        in: path
        name: check_deposit_id
        required: true
        schema:
          description: The identifier of the Check Deposit you wish to submit.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Check Deposits
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_submit_a_check_deposit_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_deposit'
          description: Check Deposit
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Submit a Check Deposit'
      x-sandbox-only: true
      x-tag: Check Deposits
      tags:
      - Simulations
  /simulations/check_transfers/{check_transfer_id}/mail:
    post:
      description: Simulates the mailing of a [Check Transfer](#check-transfers), which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a `status` of `pending_approval` or `pending_submission`.
      operationId: sandbox_mail_a_check_transfer
      parameters:
      - example: check_transfer_30b43acfu9vw8fyc4f5
        in: path
        name: check_transfer_id
        required: true
        schema:
          description: The identifier of the Check Transfer you wish to mail.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Check Transfers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/check_transfer'
          description: Check Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: 'Sandbox: Mail a Check Transfer'
      x-sandbox-only: true
      x-tag: Check Transfers
      tags:
      - Simulations
  /simulations/digital_wallet_token_requests:
    post:
      description: Simulates a user attempting to add a [Card](#cards) to a digital wallet such as Apple Pay.
      operationId: sandbox_create_a_digital_wallet_token_request
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/sandbox_create_a_digital_wallet_token_request_parameters'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inbound_digital_wa

# --- truncated at 32 KB (1466 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-simulations-api-openapi.yml