v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Sandbox: Settle an ACH Transfer

Simulates the settlement of an ACH Transfer 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.

post/simulations/ach_transfers/{ach_transfer_id}/settle

Path parameters

ach_transfer_idstring required

The identifier of the ACH Transfer you wish to become settled.

Request body

inbound_funds_hold_behavior'release_immediately' | 'release_on_default_schedule'

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.

Example request

{
  "inbound_funds_hold_behavior": "release_immediately"
}

Response

ACH Transfer

account_idstring required

The Account to which the transfer belongs.

account_numberstring required

The destination account number.

amountinteger required

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.

company_descriptive_datestring nullable required

The description of the date of the transfer.

company_discretionary_datastring nullable required

The data you chose to associate with the transfer.

company_entry_descriptionstring nullable required

The description of the transfer you set to be shown to the recipient.

company_idstring required

The company ID associated with the transfer.

company_namestring nullable required

The name by which the recipient knows you.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

currency'USD' required

The ISO 4217 code for the transfer's currency. For ACH transfers this is always equal to usd.

destination_account_holder'business' | 'individual' | 'unknown' required

The type of entity that owns the account to which the ACH Transfer is being sent.

external_account_idstring nullable required

The identifier of the External Account the transfer was made to, if any.

funding'checking' | 'savings' | 'general_ledger' required

The type of the account to which the transfer will be sent.

idstring required

The ACH transfer's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

individual_idstring nullable required

Your identifier for the transfer recipient.

individual_namestring nullable required

The name of the transfer recipient. This value is informational and not verified by the recipient's bank.

network'ach' required

The transfer's network.

pending_transaction_idstring nullable required

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.

routing_numberstring required

The American Bankers' Association (ABA) Routing Transit Number (RTN).

standard_entry_class_code'corporate_credit_or_debit' | 'corporate_trade_exchange' | 'prearranged_payments_and_deposit' | 'internet_initiated' required

The Standard Entry Class (SEC) code to use for the transfer.

statement_descriptorstring required

The descriptor that will show on the recipient's bank statement.

The lifecycle status of the transfer.

transaction_idstring nullable required

The ID for the transaction funding the transfer.

type'ach_transfer' required

A constant representing the object's type. For this resource it will always be ach_transfer.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "acknowledgement": {
    "acknowledged_at": "2020-01-31T23:59:59Z"
  },
  "addenda": null,
  "amount": 100,
  "approval": {
    "approved_at": "2020-01-31T23:59:59Z",
    "approved_by": null
  },
  "cancellation": null,
  "company_descriptive_date": null,
  "company_discretionary_data": null,
  "company_entry_description": null,
  "company_id": "1234987601",
  "company_name": "National Phonograph Company",
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "currency": "USD",
  "destination_account_holder": "business",
  "external_account_id": "external_account_ukk55lr923a3ac0pp7iv",
  "funding": "checking",
  "id": "ach_transfer_uoxatyh3lt5evrsdvo7q",
  "idempotency_key": null,
  "inbound_funds_hold": null,
  "individual_id": null,
  "individual_name": "Ian Crease",
  "network": "ach",
  "notifications_of_change": [],
  "pending_transaction_id": null,
  "preferred_effective_date": {
    "date": null,
    "settlement_schedule": "same_day"
  },
  "return": null,
  "routing_number": "101050001",
  "settlement": null,
  "standard_entry_class_code": "corporate_credit_or_debit",
  "statement_descriptor": "Statement descriptor",
  "status": "returned",
  "submission": {
    "administrative_returns_expected_by": "2020-02-05T11:00:00Z",
    "effective_date": "2020-01-31",
    "expected_funds_settlement_at": "2020-02-03T13:30:00Z",
    "expected_settlement_schedule": "future_dated",
    "submitted_at": "2020-01-31T23:59:59Z",
    "trace_number": "058349238292834"
  },
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "ach_transfer"
}