Update a correction

patch

https://sandbox.checkhq.com/corrections/{correction}

Updates an existing draft correction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
In preview
The Correction API is currently in limited preview, and is not yet generally available.

Updates a correction. Only description, settlement_date, bank_account, metadata, and simulation_mode may be updated. A correction updated webhook is sent.

Path Params

correction

string

required

ID of the correction to update

Body Params

description

string

A human-readable description of the correction.

metadata

object

Arbitrary key-value data to attach to the correction.

settlement_date

date

The CFT settlement date for the correction's money movement. Must be a valid banking day on or after the earliest date ACH can still reach for settlement. Any later banking day is allowed.

bank_account

string

Settable while the correction is in draft. ID of the bank account to debit or credit at fulfillment. Must belong to the correction's company. An explicit null re-stamps the company's current default bank account.

simulation_mode

string

enum

Sandbox-only. Settable while the correction is in draft. One of automatic or manual. Omitted leaves the mode unchanged; null resets to the default (automatic). Returns a validation error in production.

Allowed:

Response

In preview

200200