Postman Collection

Get started quickly with our pre-built Postman collection containing all Bitnob API endpoints, complete with authentication, environment variables, and automated testing.

Bitnob API Collection

Complete Postman collection with all Bitnob API endpoints

v1.0.0

Collection File

Complete API collection with all endpoints, examples, and tests

Environment File

Pre-configured environment variables for sandbox and production

Setup Instructions

Download Collection

Download the Postman collection file containing all API endpoints

Import to Postman

Open Postman → Import → Select the downloaded JSON file

Set Environment

Download and import the environment file with pre-configured variables

Configure API Key

Set your API key in the environment variables

Environment Variables

Note

base_url - API base URL (sandbox or production)

client_id - Workspace client ID from the dashboard

client_secret - Workspace client secret (HMAC-SHA256 signing key)

What's Included

Tip

All API endpoints with request examples

Pre-request scripts for authentication

Response validation tests

Environment variables for easy switching

Comprehensive error handling examples

WebHook testing utilitie

What's Included

Our Postman collection provides everything you need to test and integrate with the Bitnob API:

Complete Endpoint Coverage

Identity: GET /api/whoami — sanity-check your credentials in one call

Balances: Per-currency balances across your workspace

Addresses: Generate and manage deposit addresses for supported chains

Transactions: Paginated transaction history with filters

Withdrawals: On-chain and off-chain withdrawal flows

Exchange rates: Real-time quotes for supported pairs

Trading: Market, scheduled, and target orders (DCA + take-profit)

Bulk transfers: CSV/XLSX batch payouts with scheduled recurrence

Payouts: Single and batch payouts to bank accounts and wallets

Cards: Virtual card issuing, funding, freeze/unfreeze, spend limits, and termination

Lightning: Invoices, payments, and node operations

Customers: KYC onboarding and customer lifecycle management

Beneficiaries: Saved payout recipients

Pre-configured Features

Authentication: Collection-level pre-request script auto-generates a fresh timestamp + nonce, canonicalises the JSON body, computes HmacSHA256(client_id:timestamp:nonce:body, client_secret), and injects the X-Auth-Client, X-Auth-Timestamp, X-Auth-Nonce, and X-Auth-Signature headers — you never touch headers manually

Environment Variables: One base_url for every environment (https://api.bitnob.com) — sandbox vs production is determined by which client_id / client_secret pair you paste in, not by URL

Path parameters: quote_id and upload_id are pre-declared so chained flows (quote → execute, upload → preview → confirm) work by pasting the id from an earlier response

RFC 7807 errors: Failed responses include type, title, status, detail, correlation_id, and timestamp so you can triage directly from the Postman console

Quick Start Guide

Step 1: Download Files

Click "Download Collection" to get the main API collection

Click "Download Environment" to get pre-configured variables

Step 2: Import to Postman

Open Postman application

Click the "Import" button in the top-left

Drag and drop both downloaded JSON files

Select "Import" to confirm

Step 3: Set Up Environment

Click the environment dropdown (top-right in Postman)

Select "Bitnob API Environment"

Click the eye icon to edit environment variables

Paste your client_id and client_secret from the Bitnob dashboard — the pre-request script uses them to sign every request

Step 4: Test Your First Request

Navigate to "Identity" → "Who am I" (GET /api/whoami)

Click "Send" — the pre-request script automatically signs the call with your credentials

You should receive a 200 OK response echoing back your workspace identity — if you get a 401, your client_id/client_secret are wrong or swapped

Environment Configuration

The environment file includes these important variables:

variable	description	default value
base_url	API base URL used by every request in the collection — same host for sandbox and production (environment is determined by which credentials you use, not by URL)	https://api.bitnob.com
client_id	Workspace client ID — the pre-request script injects this as the X-Auth-Client header	(empty — paste from dashboard)
client_secret	Workspace client secret — the pre-request script uses it to compute HMAC-SHA256 for X-Auth-Signature (stored as secret, masked in the UI)	(empty — paste from dashboard)
quote_id	Path parameter for Trading quote endpoints — paste the id from a Get Quote response when you want to reuse it	(empty — set manually after creating a quote)
upload_id	Path parameter for bulk-transfer upload endpoints — paste the id returned from the presigned URL flow	(empty — set manually after requesting an upload URL)

Caution

Security Notice: client_secret is a credential — never commit it to version control. Keep your sandbox and production pairs in separate Postman environments so you can't accidentally hit production with a sandbox key (or vice versa).

WebHook Testing

Special collection items for WebHook development

Signature verification examples

Payload validation tests

Event type handling

Retry mechanism simulation

Troubleshooting Common Issues

Unauthorized Errors

Confirm client_id and client_secret are set in the active environment and haven't been swapped

Make sure base_url matches the environment your credentials were issued for (sandbox vs production)

Open the Postman Console (View → Show Postman Console) and inspect the X-Auth-* headers — a missing X-Auth-Signature means the pre-request script didn't run

If you recently rotated credentials in the dashboard, re-paste both values — the old pair becomes invalid immediately

Connection Timeouts

Check your internet connection

Verify the base URL is correct for your environment

Contact support if sandbox/production endpoints are down

Missing Environment Variables

Re-import the environment file

Manually add missing variables using the format shown above

Use pre-request script logs to identify missing variables

Getting Help

If you encounter issues:

Check the Console tab in Postman for detailed error logs

Review our API documentation for endpoint details

Visit our support center for additional help

Join our developer community for peer support

Next Steps: Grab the OpenAPI specification for code generation, or dive into specific endpoint documentation in the API Reference section.