NakaPay Node.js SDK Guide

1npm install nakapay-sdk
2# or
3yarn add nakapay-sdk

1import { NakaPay } from 'nakapay-sdk';
2
3// Replace 'YOUR_API_KEY' with your actual API key
4const nakaPay = new NakaPay('YOUR_API_KEY');
5
6// Optional: If you are self-hosting or using a different API endpoint
7// const nakaPay = new NakaPay('YOUR_API_KEY', { 
8//   baseUrl: 'https://api.nakapay.app/api/v1' 
9// });

1async function createNewPayment() {
2  try {
3    const paymentRequest = await nakaPay.createPaymentRequest({
4      amount: 100, // Amount in satoshis
5      description: 'Payment for Order #123',
6      metadata: { orderId: '123', customerId: '456' }
7    });
8
9    console.log('Payment Request Created:', paymentRequest);
10    // Example response properties:
11    // console.log('ID:', paymentRequest.id);
12    // console.log('Invoice:', paymentRequest.invoice);
13    // console.log('Status:', paymentRequest.status);
14    // console.log('Expires At:', paymentRequest.expiresAt);
15    
16    // You would typically display the invoice (e.g., as a QR code) to the user.
17
18    // Example of checking status (from SDK README)
19    setTimeout(async () => {
20      if (paymentRequest && paymentRequest.id) {
21        const statusInfo = await nakaPay.getPaymentStatus(paymentRequest.id);
22        console.log(`Payment ID ${paymentRequest.id} Status:`, statusInfo.status);
23      }
24    }, 30000);
25
26  } catch (error) {
27    console.error('Error creating payment request:', error.message);
28  }
29}
30
31createNewPayment();

1async function getPaymentDetails(paymentId) {
2  try {
3    const paymentDetails = await nakaPay.getPaymentRequest(paymentId);
4    console.log('Payment Details:', paymentDetails);
5    // paymentDetails will include amount, description, status, invoice, etc.
6  } catch (error) {
7    console.error('Error fetching payment details:', error.message);
8  }
9}
10
11// Example: getPaymentDetails('pr_xxxxxxxxxxxxxx');

1async function checkStatus(paymentId) {
2  try {
3    const statusInfo = await nakaPay.getPaymentStatus(paymentId);
4    console.log('Payment Status:', statusInfo.status);
5    // Possible statuses: 'pending', 'completed', 'failed', 'expired'
6
7    if (statusInfo.status === 'completed') {
8      console.log('Payment was successful!');
9      // Fulfill order, grant access, etc.
10    }
11  } catch (error) {
12    console.error('Error checking payment status:', error.message);
13  }
14}
15
16// Example: checkStatus('pr_xxxxxxxxxxxxxx');

1async function listPayments() {
2  try {
3    // The SDK README mentions getPayments(businessId, options), but for an API key-based SDK,
4    // the businessId might be implicit from the API key.
5    // Assuming the SDK handles this or the method doesn't require explicit businessId.
6    // If businessId is required, it should be obtained securely.
7    const payments = await nakaPay.getPayments({ // options object
8      limit: 10, 
9      offset: 0
10    });
11
12    console.log('Fetched Payments:', payments); 
13    // Assuming 'payments' is an array of PaymentRequest objects.
14    // The exact response structure (e.g., if it includes pagination) should be verified from SDK types/docs.
15    
16    payments.forEach(payment => {
17      console.log(`- ${payment.id}: ${payment.amount} sats, Status: ${payment.status}`);
18    });
19
20  } catch (error) {
21    console.error('Error listing payments:', error.message);
22  }
23}
24
25listPayments();

1async function setupWebhook() {
2  try {
3    // Assuming businessId is implicit via API key for this SDK method,
4    // or needs to be passed if the SDK requires it.
5    // The SDK README shows: registerWebhook(businessId: string, options: WebhookOptions)
6    // For this example, let's assume businessId is handled or known.
7    // const businessId = 'YOUR_BUSINESS_ID'; 
8
9    const webhookRegistration = await nakaPay.registerWebhook({ // Pass options directly if businessId is implicit
10    // const webhookRegistration = await nakaPay.registerWebhook(businessId, { // Or if businessId is needed
11      url: 'https://your-app.com/webhook-handler', 
12      events: ['payment.completed', 'payment.failed'], // Example events
13      // secret: 'your-strong-secret-for-verifying-nakapay-webhooks', // Optional: if you want to provide your own secret
14    });
15
16    console.log('Webhook Registered/Updated:', webhookRegistration);
17    // Expected response from SDK README: { success: boolean; message: string }
18    if (webhookRegistration.success) {
19      console.log(webhookRegistration.message);
20    }
21    // If NakaPay generates a secret for you to verify its webhooks, that should be handled.
22
23  } catch (error) {
24    console.error('Error registering webhook:', error.message);
25  }
26}
27
28setupWebhook();

1try {
2  // Example SDK call:
3  // const data = await nakaPay.someMethod();
4} catch (error) {
5  console.error('NakaPay SDK Error:', error.name, error.message);
6  // The error object structure might vary. Check SDK documentation for specifics.
7  // if (error.response && error.response.data) {
8  //   console.error('API Error Details:', error.response.data);
9  // }
10  // Implement user-friendly error feedback
11}