BlindPay Node.js SDK

The official Node.js SDK for BlindPay - Global payments infrastructure made simple.

Installation

npm install @blindpay/node
# or
yarn add @blindpay/node
# or
pnpm add @blindpay/node
# or
bun add @blindpay/node

Authentication

To get started, you will need both your API key and your instance id, you can obtain your API key and instance id from the BlindPay dashboard https://app.blindpay.com/instances/{instanceId}/api-keys

import { BlindPay } from '@blindpay/node';

const blindpay = new BlindPay({
    apiKey: 'your-api-key-here',
    instanceId: 'your-instance-id-here'
  })

Note

All api calls are going to use the provided api key and instance id

Quick Start

Check for available rails

async function getAvailableRails() {
    const blindpay = new BlindPay({
      apiKey: 'your-api-key-here',
      instanceId: 'your-instance-id-here'
    });

    const { data, error } = await blindpay.available.getRails();
    
    if (error) {
        throw new Error(error.message)
    }
    
    console.log('Rails: ', data)
 }

 getAvailableRails()

Response format

All API methods return a consistent response format

Success response

{
  data: /* your data */ ,
  error: null
}

Error response

{
  data: null,
  error: {
    message: "Error message"
  }
}

Error handling

This SDK uses a consistent error handling pattern. Always check for errors:

const { data, error } = await blindpay.payins.list();

if (error) {
  // Handle error
  console.error('API Error:', error.message);
  return;
}

console.log('Success:', data); // fully typed

For detailed API documentation, visit:

• BlindPay API documentation
• API Reference

Support

• 📧 Email: gabriel@blindpay.com
• 🐛 Issues: GitHub Issues

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by the BlindPay team