CHcheckhq

Update a correction

Changed on

Updates an existing draft correction. Only description, settlement_date, bank_account, metadata, and simulation_mode may be updated.

patch/corrections/{correction}

Request

Path parameters

correctionstring required

ID of the correction to update

Request body

descriptionstring

A human-readable description of the correction.

metadataobject

Arbitrary key-value data to attach to the correction.

settlement_datestring 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_accountstring

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'automatic' | 'manual'

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.

Response

200

Changes