> ## 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.

# Simulate an ACH debit from another company

> Sandbox only. Another company pulls an ACH debit from the account, as a payroll provider, tax agency or vendor would. The debit stays pending for 20 minutes, until `automaticallyResolvesAt`. With Debit Protection on, it is held and Nickel sends `held_debit.held`. Once it resolves, the bank takes the money if the account has it, and otherwise declines the debit for insufficient funds. `companyName`, `companyId` and `entryDescription` default to `SANDBOX PULL CO`, `9999999999` and `AUTOPAY`, and are uppercased. Production answers `400`. Needs "Can withdraw from Nickel Banking account".



## OpenAPI

````yaml /nickel-api-docs.yaml post /sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits
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
  - name: Nickel Banking
    description: Your Nickel Banking accounts, debit cards, check deposits and transactions
  - name: Sandbox
    description: >-
      Requests that make something happen in the sandbox that only another bank
      or company could make happen in production. Production answers them with
      `400`.
externalDocs:
  description: Find out more about Nickel
  url: https://nickel.com
paths:
  /sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits:
    post:
      tags:
        - Sandbox
      summary: Simulate an ACH debit from another company
      description: >-
        Sandbox only. Another company pulls an ACH debit from the account, as a
        payroll provider, tax agency or vendor would. The debit stays pending
        for 20 minutes, until `automaticallyResolvesAt`. With Debit Protection
        on, it is held and Nickel sends `held_debit.held`. Once it resolves, the
        bank takes the money if the account has it, and otherwise declines the
        debit for insufficient funds. `companyName`, `companyId` and
        `entryDescription` default to `SANDBOX PULL CO`, `9999999999` and
        `AUTOPAY`, and are uppercased. Production answers `400`. Needs "Can
        withdraw from Nickel Banking account".
      operationId: simulateInboundAchDebit
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxInboundAchDebitRequest'
      responses:
        '201':
          description: The debit the sandbox bank was sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxInboundAchDebitResponse'
        '400':
          description: >-
            Invalid fields, the account is still opening, or the request was
            sent to production
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          $ref: '#/components/responses/NickelBankingRefused'
        '404':
          description: No open Nickel Banking account with that ID
          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:
    SandboxInboundAchDebitRequest:
      type: object
      required:
        - amountCents
      additionalProperties: false
      properties:
        amountCents:
          type: integer
          minimum: 1
          maximum: 1000000000
          description: How much the company pulls, in cents.
          example: 1234
        companyName:
          type: string
          maxLength: 16
          description: The company pulling the debit. Defaults to `SANDBOX PULL CO`.
          example: Gusto Payroll
        companyId:
          type: string
          minLength: 1
          maxLength: 10
          description: >-
            The company's ACH Company ID, which allowed companies match on.
            Defaults to `9999999999`.
          example: '1943827561'
        entryDescription:
          type: string
          maxLength: 10
          description: What the company calls the debit. Defaults to `AUTOPAY`.
          example: PAYROLL
    SandboxInboundAchDebitResponse:
      type: object
      properties:
        simulatedDebit:
          type: object
          required:
            - accountId
            - amountCents
            - companyName
            - companyId
            - entryDescription
            - automaticallyResolvesAt
          properties:
            accountId:
              type: string
              example: cmf1nba0001qz8x4k2v7c9d3e
            amountCents:
              type: integer
              example: 1234
            companyName:
              type: string
              example: GUSTO PAYROLL
            companyId:
              type: string
              example: '1943827561'
            entryDescription:
              type: string
              example: PAYROLL
            automaticallyResolvesAt:
              type: string
              format: date-time
              description: When the bank would accept the debit on its own.
              example: '2026-11-10T22:20:00.000Z'
    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.
        code:
          type: string
          description: >-
            A stable machine-readable code, present on the errors a client can
            act on (e.g. `SHARED_ACCOUNT` on a 409 from the ACH debit
            authorization upload, `REFERENCE_CONFLICT` on a 409 from recording
            an external payment or a debit memo, `NICKEL_BANKING_NOT_ACTIVE` or
            `MISSING_PERMISSION` on a 403 from a Nickel Banking list). Absent
            otherwise.
  responses:
    NickelBankingRefused:
      description: >-
        Nickel Banking data this API key can't read. `code` is
        `NICKEL_BANKING_NOT_ACTIVE` when your organization has no active Nickel
        Banking account, or `MISSING_PERMISSION` when the team member the API
        key belongs to lacks the permission this list needs; the message names
        it. Also returned, without a `code`, for an API key without REST API
        access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.