Magpie Node.js Library

The official Magpie Node.js library for seamless integration with Magpie's payment processing APIs. Built with TypeScript and designed for modern Node.js applications.

Installation

Install the package using your preferred package manager:

npm install @magpieim/magpie-node
# or
yarn add @magpieim/magpie-node
# or
pnpm add @magpieim/magpie-node

Requirements

• Node.js 18.0.0 or higher
• TypeScript 4.5+ (for TypeScript projects)

Quick Start

Initialize the Magpie client with your secret key from the Magpie Dashboard:

JavaScript (CommonJS)

const Magpie = require('@magpieim/magpie-node');
const magpie = new Magpie('sk_test_...');

// Create a customer
magpie.customers.create({
  name: 'John Doe',
  email: '[email protected]',
})
  .then(customer => console.log('Customer created:', customer.id))
  .catch(error => console.error('Error:', error.message));

TypeScript/ES Modules

import Magpie from '@magpieim/magpie-node';

const magpie = new Magpie('sk_test_...');

// Create a customer with full type safety
const customer = await magpie.customers.create({
  name: 'John Doe',
  email: '[email protected]',
  phone: '+63917123456',
  metadata: {
    source: 'website',
    campaign: 'summer-2024'
  }
});

console.log('Customer created:', customer.id);

Core Features

Process Payments

// Create a charge
const charge = await magpie.charges.create({
  amount: 50000, // ₱500.00 in centavos
  currency: 'php',
  source: 'src_1234567890',
  description: 'Payment for Order #1234'
});

Checkout Sessions

// Create a hosted checkout page
const session = await magpie.checkout.sessions.create({
  line_items: [{
    name: 'T-shirt',
    amount: 2000,
    currency: 'php',
    quantity: 1
  }],
  success_url: 'https://example.com/success',
  cancel_url: 'https://example.com/cancel'
});

Webhook Handling

// Verify and handle webhooks
const event = magpie.webhooks.constructEvent(
  req.body, 
  req.headers['magpie-signature'], 
  webhookSecret
);

if (event.type === 'charge.succeeded') {
  console.log('Payment succeeded!', event.data.object);
}

Configuration

const magpie = new Magpie('sk_test_...', {
  timeout: 10000,
  maxNetworkRetries: 3,
  debug: true
});

Error Handling

try {
  const charge = await magpie.charges.create({...});
} catch (error) {
  if (error instanceof Magpie.AuthenticationError) {
    console.log('Invalid API key');
  } else if (error instanceof Magpie.ValidationError) {
    console.log('Invalid parameters:', error.errors);
  }
}

TypeScript Support

Full TypeScript support with comprehensive type definitions:

const customer: Magpie.Customer = await magpie.customers.create({
  name: 'John Doe',
  email: '[email protected]'
});

Maintainers

This library is maintained by the Magpie team:

• Jerick Coneras - @donjerick - Lead Maintainer
• Magpie Team - [email protected]

For feature requests and enhancements, please open an issue.

License

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

Support

• Documentation: https://docs.magpie.im
• Support: [email protected]
• Issues: GitHub Issues