Stop a lost or stolen official check: its presentment is returned

POST/transfers/checks/{id}/stop

Path parameters

idstringRequired

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

operatorstringRequired

Who acted

200 OK

account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

created_atstring · date-timeRequired

currency_codestringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

gl_codestringOptional

idstringRequired

inclearing_item_idstringOptional

issued_onstring · dateRequired

A business date, YYYY-MM-DD

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

memostringOptional

paid_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payeestringRequired

payee_addressobject or nullOptional

PostalAddress is a counterparty's mailing address.

6 child attributes

citystringRequired

country_codestringRequired

line_1stringRequired

line_2stringOptional

postal_codestringOptional

statestringOptional

remitterstringOptional

requested_bystringOptional

serialstringRequired

statusstringRequired

Issued, paid, voided, stopped

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503