README.md

react-liqpay

React component for LiqPay payment system

Install

yarn add react-liqpay

or

npm install --save react-liqpay

Usage

import React, { Component } from "react";

import { LiqPayPay, LiqPaySubscribe } from "react-liqpay";

class Example extends Component {
  const payInfo = {
    amount: 999,
    currency: 'USD',
    title: 'PAY'
  }

  const ButtonComponent = () => (
    <button style={{
      backgroundColor: '#337ab7',
      color: '#fff',
      borderColor: '#2e6da4',
      border: '1px solid transparent',
      borderRadius: '4px',
      padding: '6px 12px',
      cursor: 'pointer'
    }}>
      {`${payInfo.title} ${payInfo.amount} ${payInfo.currency}`}
    </button>
  )

  render() {
    return (
      <div style={{ display: "flex" }}>
        <LiqPayPay
          publicKey={process.env.REACT_APP_PUBLIC_KEY}
          privateKey={process.env.REACT_APP_PRIVATE_KEY}
          amount="3"
          description="Payment for product"
          currency="UAH"
          orderId={Math.floor(1 + Math.random() * 900000000)}
          result_url="http://domain.com/user/account"
          server_url="http://server.domain.com/liqpay"
          product_description="Online courses"
          style={{ margin: "8px" }}
          disabled={true}
        />
        <LiqPaySubscribe
          publicKey={process.env.REACT_APP_PUBLIC_KEY}
          privateKey={process.env.REACT_APP_PRIVATE_KEY}
          amount="3"
          subscribePeriodicity="month"
          description="Payment for subscription"
          currency="USD"
          orderId={Math.floor(1 + Math.random() * 900000000)}
          result_url="http://domain.com/user/account"
          server_url="http://server.domain.com/liqpay"
          product_description="Online courses"
          style={{ margin: "8px" }}
          disabled={false}
        />
        <LiqPayPay
          publicKey={process.env.REACT_APP_PUBLIC_KEY}
          privateKey={process.env.REACT_APP_PRIVATE_KEY}
          description="Payment for product"
          orderId={Math.floor(1 + Math.random() * 900000000)}
          result_url="http://domain.com/user/account"
          server_url="http://server.domain.com/liqpay"
          product_description="Online courses"
          style={{ margin: "8px" }}
          extra={[<ButtonComponent key="1" />]}
        />
      </div>
    );
  }
}

common props

• publicKey - String Public key - the store identifier. You can get the key in the store settings
• privateKey- String Private key of the created company (not available to anyone except your developer)
• amount - String Payment amount. For example: 5, 7.34
• description - String Payment description. (default "test")
• currency - String Payment currency. Possible values: USD, EUR, RUB, UAH, BYN, KZT. Additional currencies can be added by company's request.
• orderId - String Unique purchase ID in your shop. Maximum length is 255 symbols.
• result_url - String URL of your shop where the buyer would be redirected after completion of the purchase. Maximum length 510 symbols.
• server_url - String URL API in your store for notifications of payment status change (server->server). Maximum length is 510 symbols. Learn more
• style - Object Styles for component, like 'margin'
• disabled - Boolean Props for disabling component. (default "false")
• extra - Object Extra component for rendering as main component (default "null")

LiqPayPay props

• title - String Text showing as main text inside button. (default "Payment")

LiqPaySubscribe props

• title - String Text showing as main text inside button. (default "Subscribe")

• subscribePeriodicity - String Period of payments.

  Possible values: month - once in a month, year - once in a year (default "month")

CHANGELOG

• v1.0.0
  • initial commit
  • functional buttons with two payment actions:
    • 'pay'
    • 'subscribe'
  • example
• v1.1.0
  • example to readme
  • component picture
  • additional props in component - can pass 'style', 'result_url', 'server_url', 'product_description' etc...
  • change base64 function - support cyrillic characters
  • costume title for button
• v1.2.0
  • packages upgrade
• v1.2.1
  • typos correction
• v1.3.0
  • custom component - you can pass your own component as 'extra' props
  • refactoring
  • fixing PropTypes
  • 'disabled' props for components buttons
  • props descriptions
  • update component picture
  • updated example

License

MIT © alexneo2003