---
title: "Stop payment on a Check Transfer"
method: POST
path: "/check_transfers/{check_transfer_id}/stop_payment"
---

# Stop payment on a Check Transfer

`POST /check_transfers/{check_transfer_id}/stop_payment`

## Path parameters

- `check_transfer_id` string, required — The identifier of the Check Transfer.

## Request body

- StopPaymentOnACheckTransferParameters
  - `reason` 'mail_delivery_failed' | 'not_authorized' | 'valid_until_date_passed' | 'unknown' — The reason why this transfer should be stopped.

## Response `200`

Check Transfer

- CheckTransfer — Check Transfers move funds from your Increase account by mailing a physical check.
  - `account_id` string, required — The identifier of the Account from which funds will be transferred.
  - `account_number` string, required — The account number printed on the check.
  - `amount` integer, required — The transfer amount in USD cents.
  - `approval` object, nullable, required — If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
    - `approved_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
    - `approved_by` string, nullable, required — If the Transfer was approved by a user in the dashboard, the email address of that user.
  - `approved_inbound_check_deposit_id` string, nullable, required — If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit.
  - `balance_check` 'full' | 'none', nullable, required — How the account's available balance should be checked.
  - `cancellation` object, nullable, required — If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
    - `canceled_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
    - `canceled_by` string, nullable, required — If the Transfer was canceled by a user in the dashboard, the email address of that user.
  - `check_number` string, required — The check number printed on the check.
  - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
  - `created_by` object, nullable, required — What object created the transfer, either via the API or the dashboard.
    - `api_key` object, nullable — If present, details about the API key that created the transfer.
      - `description` string, nullable, required — The description set for the API key when it was created.
    - `category` 'api_key' | 'oauth_application' | 'user', required — The type of object that created this transfer.
    - `oauth_application` object, nullable — If present, details about the OAuth Application that created the transfer.
      - `name` string, required — The name of the OAuth Application.
    - `user` object, nullable — If present, details about the User that created the transfer.
      - `email` string, required — The email address of the User.
  - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
  - `fulfillment_method` 'physical_check' | 'third_party', required — Whether Increase will print and mail the check or if you will do it yourself.
  - `id` string, required — The Check transfer's identifier.
  - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
  - `mailing` object, nullable, required — If the check has been mailed by Increase, this will contain details of the shipment.
    - `mailed_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was mailed.
  - `pending_transaction_id` string, nullable, required — The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.
  - `physical_check` object, nullable, required — Details relating to the physical check that Increase will print and mail. Will be present if and only if `fulfillment_method` is equal to `physical_check`.
    - `attachment_file_id` string, nullable, required — The ID of the file for the check attachment.
    - `check_voucher_image_file_id` string, nullable, required — The ID of the file for the check voucher image.
    - `mailing_address` object, required — Details for where Increase will mail the check.
      - `city` string, nullable, required — The city of the check's destination.
      - `line1` string, nullable, required — The street address of the check's destination.
      - `line2` string, nullable, required — The second line of the address of the check's destination.
      - `name` string, nullable, required — The name component of the check's mailing address.
      - `phone` string, nullable, required — The phone number to be used in case of delivery issues at the check's mailing address. Only used for FedEx overnight shipping.
      - `postal_code` string, nullable, required — The postal code of the check's destination.
      - `state` string, nullable, required — The state of the check's destination.
    - `memo` string, nullable, required — The descriptor that will be printed on the memo field on the check.
    - `note` string, nullable, required — The descriptor that will be printed on the letter included with the check.
    - `payer` object[], required — The payer of the check. This will be printed on the top-left portion of the check and defaults to the return address if unspecified.
      - `contents` string, required — The contents of the line.
    - `recipient_name` string, required — The name that will be printed on the check.
    - `return_address` object, nullable, required — The return address to be printed on the check.
      - `city` string, nullable, required — The city of the check's destination.
      - `line1` string, nullable, required — The street address of the check's destination.
      - `line2` string, nullable, required — The second line of the address of the check's destination.
      - `name` string, nullable, required — The name component of the check's return address.
      - `phone` string, nullable, required — The shipper's phone number to be used in case of delivery issues. Only used for FedEx overnight shipping.
      - `postal_code` string, nullable, required — The postal code of the check's destination.
      - `state` string, nullable, required — The state of the check's destination.
    - `shipping_method` 'usps_first_class' | 'fedex_overnight', nullable, required — The shipping method for the check.
    - `signature` object, required — The signature that will appear on the check.
      - `image_file_id` string, nullable, required — The ID of a File containing a PNG of the signature.
      - `text` string, nullable, required — The text that will appear as the signature on the check in cursive font.
    - `tracking_updates` object[], required — Tracking updates relating to the physical check's delivery.
      - `category` 'in_transit' | 'processed_for_delivery' | 'delivered' | 'delivery_issue' | 'returned_to_sender', required — The type of tracking event.
      - `country` string, required — The ISO 3166-1 alpha-2 country code for the country where the event took place.
      - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the tracking event took place.
      - `postal_code` string, required — The postal code where the event took place.
  - `routing_number` string, required — The routing number printed on the check.
  - `source_account_number_id` string, nullable, required — The identifier of the Account Number from which to send the transfer and print on the check.
  - `status` 'pending_approval' | 'canceled' | 'pending_submission' | 'requires_attention' | 'rejected' | 'pending_mailing' | 'mailed' | 'deposited' | 'stopped' | 'returned', required — The lifecycle status of the transfer.
  - `stop_payment_request` CheckTransferStopPaymentRequest, required — A Check Transfer Stop Payment Request is created when a check transfer is stopped. It offsets the Check Transfer Intention.
    - `reason` 'mail_delivery_failed' | 'rejected_by_increase' | 'not_authorized' | 'valid_until_date_passed' | 'unknown', required — The reason why this transfer was stopped.
    - `requested_at` string, date-time, required — The time the stop-payment was requested.
    - `transfer_id` string, required — The ID of the check transfer that was stopped.
    - `type` 'check_transfer_stop_payment_request', required — A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
  - `submission` object, nullable, required — After the transfer is submitted, this will contain supplemental details.
    - `preview_file_id` string, nullable, required — The ID of the file corresponding to an image of the check that was mailed, if available.
    - `submitted_address` object, required — The address we submitted to the printer. This is what is physically printed on the check.
      - `city` string, required — The submitted address city.
      - `line1` string, required — The submitted address line 1.
      - `line2` string, nullable, required — The submitted address line 2.
      - `recipient_name` string, required — The submitted recipient name.
      - `state` string, required — The submitted address state.
      - `zip` string, required — The submitted address zip.
    - `submitted_at` string, date-time, required — When this check was submitted to our check printer.
    - `tracking_number` string, nullable, required — The tracking number for the check shipment.
  - `third_party` object, nullable, required — Details relating to the custom fulfillment you will perform. Will be present if and only if `fulfillment_method` is equal to `third_party`.
    - `recipient_name` string, nullable, required — The name that you will print on the check.
  - `type` 'check_transfer', required — A constant representing the object's type. For this resource it will always be `check_transfer`.
  - `valid_until_date` string, date, nullable, required — If set, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api.md) · [All operations](https://skmtc.net/increase/apis/increase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api/versions/22125d715935/schema)