increase-test
POST/simulations/ach_transfers/{ach_transfer_id}/settle

Settle an ACH transfer in the sandbox

Simulates Federal Reserve settlement of an ACH transfer in the sandbox. The transfer must be in pending_submission or submitted; settlement also submits a transfer in pending_submission. Use inbound_funds_hold_behavior to control when the resulting inbound funds hold is released; it defaults to immediate release.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
ach_transfer_idstringrequired
The identifier of the ACH transfer to settle.

Optional settlement configuration for the inbound funds hold created when the ACH transfer settles.

inbound_funds_hold_behaviorstringoptional
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.
Allowed:release_immediatelyrelease_on_default_schedule

3 status codes
200Returns the settled ACH transfer object.
account_idstringrequired
The Account to which the transfer belongs.
account_numberstringrequired
The receiver's account number.
acknowledgementobjectrequired
After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
addendaobjectrequired
Additional information that will be sent to the recipient.
amountintegerrequired
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.
approvalobjectrequired
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
cancellationobjectrequired
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
company_descriptive_datestringrequired
The description of the date of the transfer.
company_discretionary_datastringrequired
The data you chose to associate with the transfer.
company_entry_descriptionstringrequired
The description of the transfer you set to be shown to the recipient.
company_idstringrequired
The company ID associated with the transfer.
company_namestringrequired
The name by which the recipient knows you.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For ACH transfers this is always equal to `usd`.
Allowed:USD
destination_account_holderstringrequired
The type of entity that owns the receiver's account.
Allowed:businessindividualunknown
external_account_idstringrequired
The identifier of the External Account the transfer was made to, if any.
fundingstringrequired
The type of the receiver's bank account.
Allowed:checkingsavingsloangeneral_ledger
idstringrequired
The ACH transfer's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
inbound_funds_holdobjectrequired
Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.
individual_idstringrequired
Your internal identifier for the transfer recipient. This value is informational and not verified by the recipient's bank.
individual_namestringrequired
The name of the transfer recipient. This value is informational and not verified by the recipient's bank.
networkstringrequired
The transfer's network.
Allowed:ach
notifications_of_changearray<ACHTransferACHNotificationOfChange>required
If the receiving bank notifies that future transfers should use different details, this will contain those details.
pending_transaction_idstringrequired
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.
preferred_effective_dateobjectrequired
Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.
returnobjectrequired
If your transfer is returned, this will contain details of the return.
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN) of the receiver's bank.
settlementobjectrequired
A subhash containing information about when and how the transfer settled at the Federal Reserve.
standard_entry_class_codestringrequired
The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the transfer.
Allowed:corporate_credit_or_debitcorporate_trade_exchangeprearranged_payments_and_depositinternet_initiated
statement_descriptorstringrequired
The descriptor that will show on the recipient's bank statement.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalpending_transfer_session_confirmationcanceledpending_submissionpending_reviewingrequires_attentionrejectedsubmittedreturned
submissionobjectrequired
After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
transaction_idstringrequired
The ID for the transaction funding the transfer.
typestringrequired
A constant representing the object's type. For this resource it will always be `ach_transfer`.
Allowed:ach_transfer
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the service encounters a server-side error.

Error handling

The inbound_funds_hold_behavior field accepts release_immediately or release_on_default_schedule; if omitted, the hold is released immediately. The ach_transfer_id path parameter must identify an ACH transfer in pending_submission or submitted status.