xendit-node

Xendit Node SDK

The official Xendit Node SDK provides a simple and convenient way to call Xendit's REST API in applications written in Node.

• Package version: 3.0.0-beta.2

Getting Started

Installation

Requirements

Node 16.0 and later.

Install with npm

npm install xendit-node@latest --save

TypeScript support is included in this package.

Authorization

The SDK needs to be instantiated using your secret API key obtained from the Xendit Dashboard. You can sign up for a free Dashboard account here.

import { Xendit } from 'xendit-node';

const xenditClient = new Xendit({
  secretKey: SECRET_API_KEY,
})

Custom Xendit URL

By default, the SDK will use the Xendit production URL (https://api.xendit.co) to make API requests.
If you need to override the default Xendit URL, you can pass in a custom URL to the Xendit constructor.

const xenditClient = new Xendit({
  secretKey: SECRET_API_KEY,
  xenditURL: 'https://mock-server.localhost:3000',
})

Documentation

Find detailed API information and examples for each of our product’s by clicking the links below,

• BalanceAndTransaction
• PaymentRequest
• PaymentMethod
• Refund
• Invoice
• Payout

Further Reading

• Xendit Docs
• Xendit API Reference