Code Monkey home page Code Monkey logo

overshom-wayforpay's Introduction

Install

yarn add overshom-wayforpay

Overview

This is TypeScript library to work with WayForPay. Completely typed and ready to use.

More features implementation are welcome to be merged from type-safe high-quality PRs.

Usage

Below are steps to demonstrate basic flow for creating invoice and monitoring webhook on server when invoiced paid.

Initialize WFP with your credentials.

import { WFP, WFP_CONFIG } from 'overshom-wayforpay';

WFP_CONFIG.DEFAULT_PAYMENT_CURRENCY = 'UAH';

export const wfp = new WFP({
    MERCHANT_ACCOUNT: 'test_merch_n1',
    MERCHANT_SECRET_KEY: 'flk3409refn54t54t*FNJRET',
    MERCHANT_DOMAIN_NAME: 'https://product.com',
    // service URL needed to receive webhooks
    SERVICE_URL: 'https://api.product.com/wayforpay-webhook',
});

Create invoice

const response = await wfp.createInvoiceUrl({
    orderReference: (Math.random() * 1e17).toString(),
    productName: ['Product title'],
    productCount: [1],
    productPrice: [1],
});
if (response.error) {
    // return nicely handled error
}
const invoice = response.value;
// invoice structure sample
{
  invoiceUrl: 'https://secure.wayforpay.com/invoice/ib35935c03535',
  reason: 'Ok',
  reasonCode: 1100,
  qrCode: 'https://wayforpay.com/qr/img/ib35935c03535?type=i&size=200'
}

Redirect users to invoiceUrl or show them QR code so they can pay for the invoice on secure WayForPay page in browser.

Monitor invoice status changes via webhook

Using simple express server might look next:

import express from 'express';

const app = express();

app.use(express.json());

app.post(WAYFORPAY_WEBHOOK_ROUTE, (req, res) => {
    // if webhook payload corrupted / signature invalid next line will throw an error
    const data = wfp.parseAndVerifyIncomingWebhook(req.body);
    if (data.transactionStatus === 'Approved') {
        // TODO process transaction
    }
    // create special-format response for WFP server so it stops sending this webhook.
    const answer = wfp.prepareSignedWebhookResponse(data);
    res.send(answer);
});

Get currency rates

const response = await wfp.getCurrencyRates();
// see response.value for details

overshom-wayforpay's People

Contributors

overshom avatar

Stargazers

Illia avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.