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

# Open a Nickel Banking account

> Opens a Nickel Banking account for your organization, up to 10. Your organization's first account is opened in the Nickel dashboard, where the business accepts the bank's terms; this opens the ones after it. A business that uses Nickel through a platform partner accepts the terms on a page Nickel hosts, and the partner opens its first account with this request.

Always send an `idempotencyKey`. If the request times out and you retry with the same key, Nickel answers the account the first request opened instead of opening a second one.



## OpenAPI

````yaml /nickel-api-docs.yaml post /nickelBanking/accounts
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:
  /nickelBanking/accounts:
    post:
      tags:
        - Nickel Banking
      summary: Open a Nickel Banking account
      description: >-
        Opens a Nickel Banking account for your organization, up to 10. Your
        organization's first account is opened in the Nickel dashboard, where
        the business accepts the bank's terms; this opens the ones after it. A
        business that uses Nickel through a platform partner accepts the terms
        on a page Nickel hosts, and the partner opens its first account with
        this request.


        Always send an `idempotencyKey`. If the request times out and you retry
        with the same key, Nickel answers the account the first request opened
        instead of opening a second one.
      operationId: createNickelBankingAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NickelBankingAccountCreateRequest'
      responses:
        '200':
          description: >-
            The account, as opened or as an earlier request with the same
            `idempotencyKey` opened it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NickelBankingAccountResponse'
        '400':
          description: >-
            Invalid fields; Nickel Banking not yet open and its terms not
            accepted, or frozen for your organization; or 10 accounts already
            open
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          $ref: '#/components/responses/NickelBankingRefused'
        '500':
          description: >-
            Internal server error. Retrying with the same `idempotencyKey` is
            safe: it cannot open a second account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    NickelBankingAccountCreateRequest:
      type: object
      required:
        - nickname
        - idempotencyKey
      additionalProperties: false
      properties:
        nickname:
          type: string
          minLength: 1
          maxLength: 40
          description: The account's name, as your team sees it everywhere in Nickel.
          example: Payroll
        idempotencyKey:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Your key for this request. A retry with the same key answers the
            same account.
          example: open-payroll-2026-11
        debitProtectionEnabled:
          type: boolean
          description: >-
            Hold every ACH debit on the account for your review, except from
            companies you always allow. Defaults to `false`.
        defaultForReceivingPayments:
          type: boolean
          description: >-
            Opening the first account only: payments you receive settle into it
            instead of your linked bank. Defaults to `true`. Ignored for an
            additional account.
    NickelBankingAccountResponse:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/NickelBankingAccount'
    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.
    NickelBankingAccount:
      required:
        - id
        - nickname
        - accountNumberLastFour
        - balanceCents
        - pendingCardHoldsCents
        - createdAt
        - debitProtectionEnabled
      type: object
      properties:
        id:
          type: string
          example: cmf1nba0001qz8x4k2v7c9d3e
        nickname:
          type: string
          nullable: true
          description: The name you gave the account in the dashboard, if any.
          example: Operating
        accountNumberLastFour:
          type: string
          nullable: true
          description: Null while the account is still being opened.
          example: '6789'
        balanceCents:
          type: integer
          format: int64
          description: >-
            The settled balance, in cents. Nickel's record of the ledger, not a
            live read from the bank. Negative if the account is overdrawn.
          example: 1250000
        pendingCardHoldsCents:
          type: integer
          format: int64
          description: >-
            Card purchases the bank has authorized but not yet posted, in cents.
            `balanceCents` doesn't include them, so what the account can spend
            right now is `balanceCents` minus this.
          example: 4599
        debitProtectionEnabled:
          type: boolean
          description: >-
            Whether third-party ACH debits are held for your decision. See
            [Debit Protection](/concepts/nickel-banking#debit-protection).
          example: false
        createdAt:
          type: string
          format: date-time
          example: '2026-09-01T15:30:00.000Z'
  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.