INincrease

Stop a Checkbook Check

Changed on

Stop a Checkbook Check. A stopped check cannot be deposited.

post/checkbook_checks/{checkbook_check_id}/stop

Request

Path parameters

checkbook_check_idstring required

The identifier of the Checkbook Check to stop.

Response

Checkbook Check

check_numberinteger required

The check number printed on the check.

checkbook_idstring required

The identifier of the Checkbook the check belongs to.

created_atstring date-time required

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

idstring required

The Checkbook Check's identifier.

status'pending_deposit' | 'deposited' | 'stopped' | 'requires_attention' required

The status of the Checkbook Check.

type'checkbook_check' required

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

Example response

{
  "check_number": 1,
  "checkbook_id": "checkbook_7iudxhxum6vlkcjxmi8y",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "checkbook_check_klgh3z50guf6jcnfhibb",
  "status": "pending_deposit",
  "type": "checkbook_check"
}

Changes