0.2.0 • Published 4 months ago

btpay v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

BTPay

A utility library for integrating with the BT - BG PSD2 PISP (Payment Initiation Service Provider) API in React or vanilla JavaScript projects.

Overview

BTPay provides a simple, efficient way to interact with the NextGenPSD2 Framework banking API. This library handles authentication, request formatting, and response parsing for payment initiation services.

Features

  • Simple API for integrating BT-BG PSD2 PISP services
  • Secure payment flow implementation
  • Comprehensive TypeScript support
  • React hooks for easier integration
  • Zero dependencies except for axios
  • Built with TypeScript for better developer experience

Installation

npm install @dragoscatalin/btpay

Usage

Basic Payment Initiation

import { BTPay, PaymentType, Currency } from '@dragoscatalin/btpay';

// Initialize client
const btpay = new BTPay({
  apiKey: 'YOUR_API_KEY',
  environment: 'sandbox', // or 'production'
});

// Create a payment
const payment = await btpay.createPayment({
  paymentService: PaymentType.SINGLE,
  paymentProduct: 'ron-payment',
  payment: {
    debtorAccount: {
      iban: 'RO98BTRLRONCRT0ABCDEFGHI',
    },
    instructedAmount: {
      currency: Currency.RON,
      amount: '50',
    },
    creditorAccount: {
      iban: 'RO98BTRLEURCRT0ABCDEFGHI',
    },
    creditorName: 'Dan Popescu',
    debtorId: 'RO12345',
    endToEndIdentification: 'Test',
    remittanceInformationUnstructured: 'explicatii',
  },
});

// Get payment status
const status = await btpay.getPaymentStatus(payment.paymentId);

With React Hooks

import { useBTPay } from '@dragoscatalin/btpay';

function PaymentComponent() {
  const { initiatePayment } = useBTPay({
    // configuration options
  });

  // Use the hook methods
}

Vanilla JavaScript

import { BTPay } from '@dragoscatalin/btpay';

const btpay = new BTPay({
  // configuration options
});

// Use the instance methods

API Reference

See API Documentation for complete reference.

License

MIT

0.2.0

4 months ago

0.1.1

4 months ago

0.1.0

4 months ago