TransferCheck

Stop a check transfer

Create a stop payment on a single check transfer by its ID. A check can only be stopped if it is of type debit and is in issued or manual_review status. A stopped check will move into a pending_stop status with a pending_stop_at timestamp until funds are released, at which point the status will be stopped and the stopped_at timestamp will be set.

post/transfers/checks/{check_transfer_id}/stop-payment

Request

Base URL: https://api.column.com
URL: https://api.column.com/transfers/checks/{check_transfer_id}/stop-payment
Auth: HTTP basic

Path parameters

check_transfer_idstring required

Response

Successful response

account_number_idstring required

ID of the account number that is sending the transfer

allow_overdraftboolean required

Allow the account to go negative for the transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it.

attachment_document_idstring nullable required

ID of the document attached to this check transfer.

back_imagestring nullable required

Base 64 encoded TIFF image of the back of the deposited check image. This field is not populated in the check transfer object until after the check is deposited.

bank_account_idstring required

ID of the bank account that is sending the transfer

check_numberinteger nullable required

Sequence number of the check

created_atstring date-time required

Date (format: YYYY-MM-DD ) on which the check was created.

currency_codestring required

The three-letter currency code defined in ISO 4217. e.g. USD

delivered_by_columnboolean required

For an issued check, whether this check is also mailed and delivered by Column

delivery_methodstring nullable required

The delivery method for checks delivered by Column. Can be one of usps_first_class, fedex_two_day, or fedex_overnight. Defaults to usps_first_class.

delivery_statusstring nullable required

The current delivery status for checks delivered by Column. Possible statuses are created, rendered_pdf, mailed, in_transit, in_local_area, processed_for_delivery, delivered, failed, rerouted, and returned_to_sender.

delivery_tracking_numberstring nullable required

The tracking number for this check, if an expedited delivery_method is used.

delivery_tracking_urlstring nullable required

A URL to track check delivery, if an expedited delivery_method is used.

deposited_amountinteger nullable required

Amount (in cents) of the funds that are deposited. e.g. $1.75 would be represented by 175

deposited_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check is deposited (applies only to check deposited at Column).

descriptionstring nullable required

A description of the transfer visible in account statements

effective_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which a deposited check is scheduled to settle and credit the bank account (null for issued checks). A non-null value does not mean funds were credited — a returned check keeps its scheduled date; refer to status for the outcome.

external_routing_numberstring nullable required

For an issued check, this is the routing number of the bank of first deposit

extracted_payee_namestring nullable required

The payee name extracted from the ICL file supplied by the bank of first deposit (for Column issued checks only). This can be compared to the payee name on the issued check to detect fraudulently altered checks. Not guaranteed to be accurate.

first_return_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check is returned for the first time.

front_imagestring nullable required

Base 64 encoded TIFF image of the front of the deposited check image. This field is not populated in the check transfer object until after the check is deposited.

idstring required

The unique ID of the object

idempotency_keystring nullable required

The idempotency key specified in the check transfer

initiated_atstring date-time nullable required

The timestamp when the check transfer entered the initiated state.

is_preview_pdf_availableboolean required

For a check delivered by Column, whether the preview PDF is ready to be downloaded

issued_atstring date-time nullable required

Date (format: YYYY-MM-DD ) at which the check was issued.

lockbox_idstring nullable required

ID of the lockbox this check transfer was deposited from.

manual_review_atstring date-time nullable required

Date (format: YYYY-MM-DD ) at which the check transfer went into manual review.

memostring nullable required

Memo on the check. Only available for checks delivered by Column.

messagestring nullable required

Message to the payee. Only available for checks delivered by Column.

micr_lineobject nullable required

The MICR line is the sequence of numbers and characters at the bottom of a check

payee_companystring nullable required

Company name of the payee. Only available for checks delivered by Column.

payee_namestring nullable required

The name of the person who is receiving the check

pending_deposit_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was pending deposit.

pending_first_return_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was pending first return.

pending_second_return_atstring date-time nullable required

The timestamp at which the check entered pending_second_return.

pending_stop_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was stopped.

pending_user_initiated_return_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the user initiates the return.

positive_pay_amountinteger nullable required

Amount (in cents) of the issued check that will be used in positive pay validation if account number is provided. e.g. $1.75 would be represented by 175.

pre_review_atstring date-time nullable required

The timestamp when transfer approval became required for the check transfer, awaiting approval.

reclear_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was recleared.

rejected_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was rejected.

returned_atstring date-time nullable required

Date (format YYYY-MM-DD) on which the check was returned

second_return_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was returned for the second time.

settled_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the check was settled.

statusstring required

The current status of the check transfer. Possible statuses are initiated, pre_review, issued, manual_review, rejected, pending_deposit, pending_stop, deposited, stopped, pending_first_return, pending_second_return, first_return, pending_reclear, recleared, second_return, settled, returned, pending_user_initiated_return, user_initiated_return_submitted, user_initiated_returned, and pending_user_initiated_return_dishonored.

stopped_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which funds locked for a check in a pending_stop state are made available.

transfer_batch_idstring nullable required

ID of the transfer batch this check belongs to.

typestring required

Check transfer type. For checks deposited at Column, this is credit. For checks issued by Column and deposited at another FI, this is debit. Learn more here.

updated_atstring date-time required

The timestamp at which the Check transfer was last updated

user_initiated_return_dishonored_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the user initiated return is dishonored.

user_initiated_return_submitted_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the user initiated return is submitted to the Fed.

user_initiated_returned_atstring date-time nullable required

Date (format: YYYY-MM-DD ) on which the user initiated return is completed.

void_datestring date nullable required

Date the check is automatically voided

Example response

{
  "lockbox_id": "lbox_3VqZkz3FNgKx24u8FQeGMB1L4mU"
}

Changes

No recorded changes to this operation across all 1 revision of this API.