https://github.com/xendit/xendit-node
Xendit REST API Client for Node.js - Card, Virtual Account, Invoice, Disbursement, Recurring Payments, Payout, EWallet, Balance, Retail Outlets, QR Codes, Direct Debit
https://github.com/xendit/xendit-node
balance card direct-debit disbursement ewallet hacktoberfest invoice javascript payment payment-gateway payout qr-payments recurring-payments retail-outlet virtual-account xendit
Last synced: 2 months ago
JSON representation
Xendit REST API Client for Node.js - Card, Virtual Account, Invoice, Disbursement, Recurring Payments, Payout, EWallet, Balance, Retail Outlets, QR Codes, Direct Debit
- Host: GitHub
- URL: https://github.com/xendit/xendit-node
- Owner: xendit
- Created: 2019-09-26T00:26:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-10-01T15:14:25.000Z (6 months ago)
- Last Synced: 2025-10-01T17:24:49.198Z (6 months ago)
- Topics: balance, card, direct-debit, disbursement, ewallet, hacktoberfest, invoice, javascript, payment, payment-gateway, payout, qr-payments, recurring-payments, retail-outlet, virtual-account, xendit
- Language: TypeScript
- Homepage: https://developers.xendit.co/api-reference/
- Size: 1.58 MB
- Stars: 142
- Watchers: 23
- Forks: 67
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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: 7.0.0
# Getting Started
## Installation
### Requirements
Node 18.0 and later.
### Install with npm
```bash
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](https://dashboard.xendit.co/settings/developers#api-keys).
You can sign up for a free Dashboard account [here](https://dashboard.xendit.co/register).
```typescript
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.
```typescript
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,
* [Invoice](docs/Invoice.md)
* [PaymentRequest](docs/PaymentRequest.md)
* [PaymentMethod](docs/PaymentMethod.md)
* [Refund](docs/Refund.md)
* [Transaction](docs/Transaction.md)
* [Balance](docs/Balance.md)
* [Customer](docs/Customer.md)
* [Payout](docs/Payout.md)
Further Reading
* [Xendit Docs](https://docs.xendit.co/)
* [Xendit API Reference](https://developers.xendit.co/)