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

# Stop payment on a check bill payment

> Stops payment on a check bill payment that has already been issued but not yet deposited. Pre-mail checks are cancelled and mailed checks are stopped through the bank; either way the merchant is automatically refunded and the bill is returned to unpaid. A check that has already been deposited can no longer be stopped. Use the cancel endpoint for a bill payment whose check has not been issued yet.



## OpenAPI

````yaml /nickel-api-docs.yaml post /billPayment/{billPaymentId}/stopPayment
openapi: 3.0.3
info:
  title: Nickel API
  description: >-
    This is the specification for the Nickel Rest API. The API lets you
    programmatically interact with the Nickel server. It uses resource oriented
    URLs, accepts and returns JSON encoded payloads and uses standard HTTP
    response codes. It is not a direct API to move money, but instead allows you
    to interact with Nickel as you would on a web interface.
  termsOfService: https://www.nickel.com/terms-of-service
  contact:
    email: support@nickel.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
  - url: https://rest.staging.nickel.com
    description: Sandbox / Staging
  - url: https://rest.nickel.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Payment
    description: Payments from your customers to you
  - name: Disbursement
    description: Payouts made from Nickel to you
  - name: Payment Link
    description: A request for payment against an invoice
  - name: Customer
    description: A customer record to request payments against
  - name: Charge Authorization
    description: >-
      An authorization for your customer to allow you to charge their payment
      method directly
  - name: Webhook
    description: Create a webhook for nickel to send updates to
  - name: File
    description: A file you can use to attach to invoices or debit authorizations
  - name: Vendor
    description: Manage vendors for accounts payable
  - name: Bill
    description: Bills from vendors and bill payments
  - name: Bill Payment Method
    description: >-
      A merchant's payment methods used to pay bills (bank accounts and cards on
      file)
  - name: Vendor Delivery Method
    description: >-
      How a vendor receives funds — bank account (ACH), check mailing address,
      or international wire (SWIFT) details
externalDocs:
  description: Find out more about Nickel
  url: https://nickel.com
paths:
  /billPayment/{billPaymentId}/stopPayment:
    post:
      tags:
        - Bill
      summary: Stop payment on a check bill payment
      description: >-
        Stops payment on a check bill payment that has already been issued but
        not yet deposited. Pre-mail checks are cancelled and mailed checks are
        stopped through the bank; either way the merchant is automatically
        refunded and the bill is returned to unpaid. A check that has already
        been deposited can no longer be stopped. Use the cancel endpoint for a
        bill payment whose check has not been issued yet.
      operationId: stopCheckPayment
      parameters:
        - name: billPaymentId
          in: path
          description: ID of the check bill payment to stop
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillPayment'
        '400':
          description: >-
            The bill payment cannot be stopped (e.g. the check has already been
            deposited, the payment is not a check, or the check was not issued
            through Increase).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Bill payment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BillPayment:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          nullable: true
        amountInCents:
          type: integer
          format: int64
          nullable: true
        createdAt:
          type: number
          nullable: true
        vendorDeliveryMethodId:
          type: string
          nullable: true
          description: ID of the vendor delivery method the funds were sent to.
        vendorPayoutMethodId:
          type: string
          nullable: true
          deprecated: true
          description: >-
            Deprecated alias of vendorDeliveryMethodId, retained for backwards
            compatibility.
        billPayableId:
          type: string
          description: >-
            Opaque ID grouping the payment attempts made against one bill. Not
            directly retrievable through the API; use the bill and bill payment
            endpoints instead.
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
          description: >-
            A human-readable error message describing what went wrong. Note that
            some 500 responses may return a plain text string instead of this
            JSON object.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````