Skip to content

Corgi BankDocumentation

OpenAPI

The Stop Payment object

StopPayment is a stop payment order.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

achobject or nullOptional

7 child attributes

company_idstringOptional

company_namestringOptional

individual_idstringOptional

received_onstring · dateRequired

A business date, YYYY-MM-DD

revokedbooleanRequired

scheduled_onstring · dateRequired

A business date, YYYY-MM-DD

timelybooleanRequired

amountintegerOptional

check_number_highstringRequired

check_number_lowstringRequired

created_atstring · date-timeRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

expires_atstring · date-timeRequired

fee_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

kindstringOptional

matchesintegerRequired

payeestringOptional

reasonstringOptional

released_atstring · date-time or nullOptional

released_bystringOptional

The verified operator who lifted the order

requested_bystringOptional

statusstringRequired

Active, released, expired

writtenbooleanRequired

The Stop Payment object

{
  "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "ach": {
    "company_id": "string",
    "company_name": "string",
    "individual_id": "string",
    "received_on": "2026-09-17",
    "revoked": false,
    "scheduled_on": "2026-09-17",
    "timely": false
  },
  "amount": 10000,
  "check_number_high": "string",
  "check_number_low": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "expires_at": "2026-09-17T14:30:00Z",
  "fee_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "id": "string",
  "kind": "string",
  "matches": 0,
  "payee": "string",
  "reason": "string",
  "released_at": "2026-09-17T14:30:00Z",
  "released_by": "string",
  "requested_by": "string",
  "status": "string",
  "written": false
}