Stop Payment Resources

Unit supports two types of stop payment resources:

Check Stop Payment

The checkStopPayment resource is used to stop check payments based on check number and optionally amount.

See Check Stop Payment for the full resource schema.

Key Attributes

Attribute	Type	Description
status	string	The status of the stop payment, one of Active or Disabled.
checkNumber	string	The check number of the check payments that the stop payment operation will be applied to.
amount	integer	Optional. The amount (in cents) to look on payments to stop.
createdAt	string	The date the resource was created.

Relationships

Relationship	Type	Description
account	Account	The account that payments will be stopped for.
customer	Customer	The customer that owns the account.
stoppedPayments	Array of CheckPayment	Optional. The list of check payments that were stopped by this stop payment.

ACH Stop Payment

The achStopPayment resource is used to stop ACH debit payments based on originator name and/or minimum amount.

See ACH Stop Payment for the full resource schema.

Key Attributes

Attribute	Type	Description
status	string	The status of the stop payment, one of Active or Disabled.
minAmount	integer	Optional. The amount (in cents) above which a payment will be stopped.
originatorName	Array of strings	Optional. The name of the originator of the payment to look for in payments to stop.
direction	string	Debit only.
expiration	string	Optional. Date only (e.g. "2001-08-15").
isMultiUse	boolean	Optional. False by default.
description	string	Up to 255 characters.
createdAt	string	The date the resource was created.

Relationships

Relationship	Type	Description
account	Account	The account that payments will be stopped for.
customer	Customer	The customer that owns the account.