title: "Postman Collection" description: "Download and import our comprehensive Postman collection with all Bitnob API endpoints" order: 1


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

1
Download Collection

Download the Postman collection file containing all API endpoints

2
Import to Postman

Open Postman → Import → Select the downloaded JSON file

3
Set Environment

Download and import the environment file with pre-configured variables

4
Configure API Key

Set your API key in the environment variables

Environment Variables

Note

baseUrl - API base URL (sandbox/production)

apiKey - Your API key from the dashboard

webhookSecret - Webhook signature verification

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

Wallets: Create, list, and manage wallets

Transactions: View transaction history and details

Transfers: Internal and external transfers

Authentication: API key verification

WebHooks: Testing and validation utilities

Pre-configured Features

Authentication: Automatic Bearer token handling

Environment Variables: Switch between sandbox and production

Request Validation: Pre-request scripts ensure all required fields

Response Testing: Automated tests verify API responses

Error Handling: Comprehensive error scenario examples

Quick Start Guide

Step 1: Download Files
1

Click "Download Collection" to get the main API collection

2

Click "Download Environment" to get pre-configured variables

Step 2: Import to Postman
1

Open Postman application

2

Click the "Import" button in the top-left

3

Drag and drop both downloaded JSON files

4

Select "Import" to confirm

Step 3: Set Up Environment
1

Click the environment dropdown (top-right in Postman)

2

Select "Bitnob API Environment"

3

Click the eye icon to edit environment variables

4

Replace your_api_key_here with your actual API key from the Bitnob dashboard

Step 4: Test Your First Request
1

Navigate to "Authentication" → "Verify API Key"

2

Click "Send" to test your API key

3

You should receive a 200 OK response with your account details


Environment Configuration

The environment file includes these important variables:

variable
description
default value
baseUrl
API base URL
https://api.sandbox.bitnob.com/api/v1
productionBaseUrl
Production URL
https://api.bitnob.com/api/v1
api_key
Your API key
your_api_key_here
webhookSecret
WebHook secret
your_webhook_secret_here
walletId
Sample wallet ID
Auto-populated after wallet creation
Caution

Security Notice: Never commit your API keys to version control. Keep your production and sandbox keys separate and secure.


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

Verify your API key is correctly set in environment variables

Check that you're using the right environment (sandbox/production)

Ensure API key has proper permissions in Bitnob dashboard

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: Try our Interactive API Explorer for browser-based API testing, or dive into specific endpoint documentation in the API Reference section.


Share on
Share on FacebookShare on XShare on LinkedIn
Did you find this page useful?