npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

beans-merchant-sdk

v2.0.0

Published

Beans Merchant API Library

Downloads

90

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

q-barzq-barz

Keywords

beansmerchantapistellarqr

Readme

npm version

Introduction

The Beans Merchant SDK offers a comprehensive toolkit for integrating the advanced payment capabilities of the Beans platform directly into your JavaScript applications. This SDK is designed to simplify the integration process, allowing you to leverage the Beans Merchant API's full potential without needing to manage the intricacies of direct API calls. By incorporating the Beans Merchant SDK, developers can unlock a wide range of use cases.

Use Cases

  • Build an In-Person Merchant POS: Facilitate in-person point of sale at stores or restaurants by generating payment requests through QR codes. This combines the convenience of online transactions with the traditional in-store shopping experience.

  • Shopify App for Currency Flexibility: Develop a Shopify application that empowers merchants to request payments in their preferred currency while offering customers the flexibility to pay in theirs. This functionality enhances the shopping experience, catering to a global customer base.

  • Integrate Beans as Your On/Off Ramp Partner: Streamline your application's payment infrastructure by using Beans as your central on/off ramp partner. This integration saves significant development time and resources by eliminating the need to individually integrate multiple on/off ramp solutions.

  • Monetize Your GPT Applications: For applications utilizing Generative Pre-trained Transformers (GPT), integrating Beans enables a monetization strategy where services can be accessed for free up to a certain limit, after which users are prompted to pay for additional usage or to purchase credits. This model is perfect for applications offering premium content or services on a per-use basis.

Getting Started

How to Request an Account

Welcome to Beans App! To start your journey as a merchant, please request an account by contacting us. Follow the steps below to ensure your application is processed smoothly.

Reach out to us via email at [email protected] with the following required details:

Company Details

  • Company Name: Provide the official name of your company.
  • Company Website: Include the URL to your business website.
  • Company Email Address: This should be the official contact email for your business.
  • Company Logo: Attach a high-resolution logo (minimum dimensions 500x500 pixels).

Stellar Account Details

To handle payments, please provide your Stellar account details:

  • Beans App Account (reccomended):
    • Username: Provide your Beans App username.
    • Recommendation: Using a Beans App account simplifies the withdrawal process.
    • New Users: To create a Beans App account, download the app here.
  • Custom Stellar Account:
    • Public Key: Provide the public key if you prefer to receive payments in a custom Stellar account.

Thank you for choosing Beans App. We look forward to facilitating your business transactions!

Installation

You can install the package using npm:

npm install beans-merchant-sdk

Usage

import {BeansMerchantSdk, BeansMerchantSdkEnvironment}  from '../node_modules/beans-merchant-sdk/dist/sdk.js';

// Create an instance of BeansMerchantSdk
const sdk = new BeansMerchantSdk(BeansMerchantSdkEnvironment.STAGING, 'your-api-key');

// Fetch currencies
sdk.fetchCurrencies('stellarAccountId')
  .then((response: FetchStellarCurrenciesResponse) => {
    console.log('Available currencies:', response.stellarCurrencies);
  });

// Generate deeplink
sdk.generateDeeplink('stellarAccountId', 'stellarCurrencyId', 100, 'memo', 1, 'https://your-domain.com/webhook')
  .then((response: DeeplinkResponse) => {
    console.log('Generated deeplink:', response.deeplink);
  });

// Generate SVG QR code
sdk.generateSvgQRCode('stellarAccountId', 'stellarCurrencyId', 100, 'memo', 1, 'https://your-domain.com/webhook', 250)
  .then((response: SvgQrCodeResponse) => {
    console.log('Generated deeplink:', response.deeplink);
    console.log('Generated SVG QR code:', response.svgQrCode);
  });

// Generate PNG QR code
merchant.generatePngQRCode('stellarAccountId', 'stellarCurrencyId', 100, 'memo', 1, 'https://your-domain.com/webhook', 250)
  .then((response: PngQrCodeResponse) => {
    console.log('Generated deeplink:', response.deeplink);
    console.log('Generated PNG QR code:', response.pngQrCodeBase64String);
  });

API Reference

The Beans Merchant SDK provides a simple and intuitive interface for interacting with the Beans Merchant API. This section outlines the available methods and response objects provided by the SDK.

BeansMerchantSdk

The BeansMerchantSdk class provides methods for interacting with the Beans Merchant API.

Constructor

BeansMerchantSdk(...): Initializes a new SDK instance.

Parameters:

  • environment: API environment (STAGING or PRODUCTION).
  • apiKey: Your Beans Merchant API key.

Methods

Fetch Stellar Currencies

Retrieves available Stellar currencies for the specified account.

Method Signature: Promise<FetchStellarCurrenciesResponse> fetchStellarCurrencies(...)

Parameters:

  • stellarAccountId: Your Stellar account ID.

Returns: Promise<FetchStellarCurrenciesResponse>: A promise that resolves with the response object containing the available Stellar currencies.

Return Object Properties:

  • stellarCurrencies: An array of Stellar currencies accessible for the specified Stellar Account.

Example:

sdk.fetchCurrencies('stellarAccountId')
  .then((response: FetchStellarCurrenciesResponse) => {
    console.log('Available currencies:', response.stellarCurrencies);
  });

Generate Deeplink

Creates a payment request deeplink.

Method Signature: Promise<DeeplinkResponse> generateDeeplink(...)

Parameters:

  • stellarAccountId: Your Stellar account ID.
  • currencyId: Stellar currency ID.
  • amount: Amount for the payment request.
  • memo: Memo for the payment request.
  • maxAllowedPayments: (Optional) Maximum number of payments allowed for the payment request.
    • Unlimited is -1
    • Default is 1
  • webhookUrl: (Optional) Webhook URL for payment received notification.

Returns: Promise<DeeplinkResponse>: A promise that resolves with the response object containing the payment request deeplink.

Return Object Properties:

  • id: The ID of the payment request.
  • deeplink: The Beans App deeplink for the payment request.

Example:

sdk.generateDeeplink('stellarAccountId', 'stellarCurrencyId', 100, 'memo', 1, 'https://your-domain.com/webhook')
  .then((response: DeeplinkResponse) => {
    console.log('Generated deeplink:', response.deeplink);
  });

Generate PNG QR Code

Generates a PNG QR code for payment requests.

Method Signature: Promise<PngQrCodeResponse> generatePngQrCode(...)

Parameters:

  • stellarAccountId: Your Stellar account ID.
  • currencyId: Stellar currency ID.
  • amount: Amount for the payment request.
  • memo: Memo for the payment request.
  • maxAllowedPayments: (Optional) Maximum number of payments allowed for the payment request.
    • Unlimited is -1
    • Default is 1
  • webhookUrl: (Optional) Webhook URL for payment received notification.
  • preferredSize: (Optional) Preferred size of the QR code. We will try to generate a QR code with a size as close as possible to the preferred size provided.

Returns: Promise<PngQrCodeResponse>: A promise that resolves with the response object containing the payment request PNG QR code.

Return Object Properties:

  • id: The ID of the payment request.
  • deeplink: The Beans App deeplink for the payment request.
  • pngQrCodeBase64String: The base64 encoded PNG QR code containing the deeplink.

Example:

sdk.generatePngQRCode('stellarAccountId', 'stellarCurrencyId', 100, 'memo', 1, 'https://your-domain.com/webhook', 250)
  .then((response: PngQrCodeResponse) => {
    console.log('Generated deeplink:', response.deeplink);
    console.log('Generated PNG QR code:', response.pngQrCodeBase64String);
  });

Generate SVG QR Code

Generates an SVG QR code for payment requests.

Method Signature: Promise<SvgQrCodeResponse> generateSvgQrCode(...)

Parameters:

  • stellarAccountId: Your Stellar account ID.
  • currencyId: Stellar currency ID.
  • amount: Amount for the payment request.
  • memo: Memo for the payment request.
  • maxAllowedPayments: (Optional) Maximum number of payments allowed for the payment request.
    • Unlimited is -1
    • Default is 1
  • webhookUrl: (Optional) Webhook URL for payment received notification.
  • size: (Optional) Size of the QR code.

Returns: Promise<SvgQrCodeResponse>: A promise that resolves with the response object containing the payment request SVG QR code.

Return Object Properties:

  • id: The ID of the payment request.
  • deeplink: The Beans App deeplink for the payment request.
  • svgQrCode: The SVG QR code containing the deeplink.

Example:

sdk.generateSvgQRCode('stellarAccountId', 'stellarCurrencyId', 100, 'memo', 1, 'https://your-domain.com/webhook', 250)
  .then((response: SvgQrCodeResponse) => {
    console.log('Generated deeplink:', response.deeplink);
    console.log('Generated SVG QR code:', response.svgQrCode);
  });

Webhook Notifications

Beans Merchant API sends a webhook notification to the provided URL when a payment is received.

Example Webhook Payload:

{
  "PaymentRequestId": "e3cfa903-548f-475c-a9f2-ebf3f4e2fa17",
  "Memo": "example",
  "TransactionHash": "b7f4e42935eb120e3a6f43cdae3c6a511a346da77b7e17299aff0f8c72dcf3c0"
}

Questions and Answers

Do I have to use stroops?

Our platform utilizes Stellar blockchain technology to simplify digital transactions, making it accessible even to those unfamiliar with cryptocurrencies. We've streamlined the payment process using Stellar Lumen (XLM) and other cryptocurrencies, allowing you to transact in main currency units instead of dealing with complex conversions like stroops. For example, to request a payment of 1 XLM, you just set the amoun to "1" and our system automatically handles the conversion to 10,000,000 stroops, ensuring a user-friendly payment experience.