Create a stop payment
POST
/stop-paymentsOrder the bank not to pay a check or a range of checks
Headers
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
achobject or nullOptional7 child attributes
company_idstringOptionalcompany_namestringOptionalindividual_idstringOptionalreceived_onstring · dateRequiredA business date, YYYY-MM-DD
revokedbooleanRequiredscheduled_onstring · dateRequiredA business date, YYYY-MM-DD
timelybooleanRequiredamountintegerOptionalcheck_numberstringRequiredcheck_number_highstringOptionalkindstringOptionaloralbooleanOptionalFourteen days unless confirmed in writing; written orders last six months
payeestringOptionalreasonstringOptionalrequested_bystringRequiredReturns
201 Created
The Stop Payment object.
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503