> ## Documentation Index
> Fetch the complete documentation index at: https://developers.ingopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Stop

> Request a stop payment on an Ingo-issued check in check_issued status.



## OpenAPI

````yaml specs/ingopay-check-stop.yaml POST /gateway/checkstop
openapi: 3.0.3
info:
  title: IngoPay API — Check Stop
  description: >
    Submit a request to stop payment on a previously issued check disbursement.


    The Check Stop method is used to request that a previously accepted check
    payment be placed in a stop status. **This does not guarantee the check will
    be stopped.** The check must be in an issued status. A successful response
    confirms the stop request has been submitted — confirmation of the actual
    stop is communicated via webhook event.


    **Reason codes for Check Stop:**

    | Code | Description | |---|---| | `77` | Client Request | | `78` | Internal
    Request |


    > **Check Stop is a SaaS-only endpoint.** Your participant account must be
    configured as a SaaS participant with check disbursement capability. Contact
    your Ingo integration manager to confirm your configuration.


    > **Ledger clients:** `ledger{}` is required when the client is configured
    for ledger service.
  version: '1'
  contact:
    name: Ingo Money Developer Support
    url: https://developers.ingomoney.com
servers:
  - url: https://payapi-sandbox.ingo.money
    description: Sandbox
  - url: https://payapi.ingo.money
    description: Production
security:
  - HmacAuth: []
paths:
  /gateway/checkstop:
    post:
      tags:
        - Check Management
      summary: Stop payment on an issued check
      description: >
        Submits a stop payment request for a previously issued check
        disbursement. The check is located by exact match on `participant_id`,
        `check_number`, `amount`, and `participant_unique_id1`. The check must
        be in an issued status to be eligible for a stop request.
      operationId: checkStop
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckStopRequest'
            example:
              participant_id: '12345'
              check_number: '49379283'
              amount: 100.04
              reason_code: 77
              explanation: Duplicate deposit
              participant_unique_id1: fc12512a-e934-447c-9316-7d2d4a86230a
      responses:
        '200':
          description: Check stop request submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckStopResponse'
              example:
                status_code: 100
                client_message: Success
                data:
                  check_number: '49379283'
                  transaction_id: 2361542
                  request_timestamp: 1633470601
                  participant_unique_id1: fc12512a-e934-447c-9316-7d2d4a86230a
                time: '0.8821'
        '400':
          description: Validation error or check not eligible for stop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status_code: 721
                client_message: Check Invalid To Stop
components:
  schemas:
    CheckStopRequest:
      type: object
      required:
        - participant_id
        - check_number
        - amount
        - reason_code
        - explanation
        - participant_unique_id1
      properties:
        participant_id:
          type: string
          maxLength: 5
          description: Unique participant identifier assigned by Ingo.
          example: '12345'
        check_number:
          type: string
          maxLength: 10
          description: >
            Check number assigned to the check disbursement transaction.
            Provided in the Process call response (`check_number` field).
          example: '49379283'
        amount:
          type: number
          format: float
          minimum: 0.01
          description: >
            Amount of the transaction. Must exactly match the original
            transaction amount.
          example: 100.04
        reason_code:
          type: integer
          enum:
            - 77
            - 78
          description: >
            Reason code associated with the check stop request. 77 = Client
            Request. 78 = Internal Request.
          example: 77
        explanation:
          type: string
          minLength: 1
          maxLength: 80
          description: Brief explanation for the check stop request.
          example: Duplicate deposit
        participant_unique_id1:
          type: string
          minLength: 1
          maxLength: 255
          description: >
            Participant assigned unique ID for the original check Process
            request. Must exactly match the original value.
          example: fc12512a-e934-447c-9316-7d2d4a86230a
        ledger:
          $ref: '#/components/schemas/Ledger'
    CheckStopResponse:
      type: object
      properties:
        status_code:
          type: integer
          description: >
            Numeric code describing the status of the API request. 100 =
            Success.
          example: 100
        client_message:
          type: string
          description: Text description associated with the status code.
          example: Success
        data:
          type: object
          description: Information about identifiers associated with the transaction.
          properties:
            check_number:
              type: string
              description: >
                Check number assigned to the check disbursement transaction and
                provided in the Process call response.
              example: '49379283'
            transaction_id:
              type: integer
              description: Ingo assigned unique ID for the original request.
              example: 2361542
            request_timestamp:
              type: integer
              format: int64
              description: Unix timestamp of the request.
              example: 1633470601
            participant_unique_id1:
              type: string
              description: Participant assigned unique ID for the original request.
              example: fc12512a-e934-447c-9316-7d2d4a86230a
        time:
          type: string
          description: Time in seconds to complete the request.
          example: '0.8821'
    ErrorResponse:
      type: object
      properties:
        status_code:
          type: integer
          example: 721
        client_message:
          type: string
          example: Check Invalid To Stop
    Ledger:
      type: object
      description: >
        Required for clients configured for ledger service. Exclude entirely if
        not applicable to your integration.
      required:
        - api_key
        - user_id
        - entity_type
        - entity_id
      properties:
        api_key:
          type: string
          minLength: 1
          maxLength: 100
          description: API key associated with the ledger program.
          example: lk_live_abc123xyz
        user_id:
          type: string
          minLength: 1
          maxLength: 100
          description: User ID associated with the ledger program.
          example: usr_00456
        entity_type:
          type: string
          minLength: 1
          maxLength: 50
          enum:
            - program
            - business
            - user
          description: >
            Entity type for the ledger. Accepted values: `program`, `business`,
            `user`.
          example: program
        entity_id:
          type: string
          maxLength: 100
          nullable: true
          description: Entity ID associated with the ledger.
          example: ent_00789
  securitySchemes:
    HmacAuth:
      type: http
      scheme: hmac-sha512
      description: >-
        HMAC-SHA512 signed Authorization header. See the Authentication page for
        the complete signing guide.

````