Skip to main content

Getting Started with the Nickel API

Nickel's API lets you connect invoicing, payments, and bill pay directly into the tools you already use — whether that's your ERP, CRM, or custom internal software. This article covers what you need to know to get started.

Who can access the API?

API access is available exclusively to Nickel Pro customers ($375/month, or $300/month billed annually). If you're on another plan and would like to upgrade, contact our team to get started.


What can you do with the API?

The Nickel API gives you programmatic access to the same core features available in the Nickel dashboard:

  • Send payment links: Create invoices and request payment from your customers.
    ​

  • Create and onboard customers: Add new customers and securely save their payment methods on file.
    ​

  • Charge payment methods on file: Automatically charge a saved payment method and apply it against open invoices.
    ​

  • Create and pay bills: Pay your vendors using ACH, credit card, or check.
    ​

  • Onboard vendors: Request vendor payment details and securely store them in Nickel.
    ​

  • Receive real-time updates via webhooks: Get notified when payments are completed, fail, or are updated.


What you can't do with the API

Nickel is a B2B invoicing and bill pay platform. There are a few use cases the API does not support:

  • Use Nickel as a payment gateway. Nickel is not a standalone payments gateway like Stripe or Adyen. It does not provide direct access to credit card processing, tokenization, or other gateway-level services.
    ​

  • Power an e-commerce checkout. The API is built for invoice-based B2B payments, not for shopping carts or e-commerce checkout flows.
    ​

  • Build a third-party payments platform (ISV integration). Nickel is designed for businesses integrating their own tools. We do not support integrations with independent software vendors (ISVs) or third parties building software platforms or payments solutions on top of Nickel.


Technical overview

The Nickel API is a modern REST API that accepts and returns JSON. Here are the basics:

  • Authentication: Bearer token authentication. When you sign up for API access, you'll receive two API keys — one for production and one for the sandbox.
    ​

  • Base URLs:

    • Production: https://rest.nickel.com

    • Sandbox: https://rest.staging.nickel.com
      ​

  • Requests: Use Content-Type: application/json for POST requests (parameters in the JSON body). For GET requests, pass parameters in the query string.
    ​

  • Errors: The API uses standard HTTP response codes (2xx for success, 4xx for client errors, 5xx for server errors). When a request fails, the response body is a JSON object with an error field containing a human-readable description of the problem.


Sandbox environment

Nickel provides a full sandbox environment so you can build and test your integration without touching live data. No real money moves in sandbox mode. Use your sandbox API key and direct requests to https://rest.staging.nickel.com.


Security

Every API call is protected by bank-grade security:

  • PCI compliance: Credit card and bank account data is secured to PCI standards at all times.
    ​

  • SOC 2 compliance: Nickel is audited quarterly to meet SOC 2 requirements.
    ​

  • Encryption & tokenization: All payment data is encrypted and tokenized using industry-standard protocols.


Do I need a developer?

Yes. You'll need someone with basic development experience to build and maintain your integration. That said, our engineering team works directly with you throughout the process — from initial setup to going live.


Connecting to QuickBooks?

If your goal is to connect Nickel to QuickBooks, you don't need the API. Nickel has a native integration with both QuickBooks Online and QuickBooks Desktop that you can set up in minutes with no code. The API is for connecting Nickel to tools where a native integration doesn't already exist.


Full API documentation

For endpoint references, request/response schemas, and webhook details, visit the full API docs: Nickel API Documentation
​

Need help?

If you have questions, please chat with our team via the Help Center when you login to the platform.

Did this answer your question?