Socket
Socket
Sign inDemoInstall

shopier-api

Package Overview
Dependencies
0
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    shopier-api

Shopier Payment Api


Version published
Weekly downloads
14
Maintainers
1
Install size
35.3 kB
Created
Weekly downloads
 

Changelog

Source

1.1.4

Patch Changes

  • 115ffb8: refactoring and few fixes

Readme

Source

Shopier Api

Usage:

npm install shopier-api
Create an instance of the Shopier class.
import { Shopier } from 'shopier-api';      //CommonJS
const { Shopier } = require('shopier-api')  //ES


const shopier = new Shopier('apiKey', 'apiSecret');
Set the buyer's information.
shopier.setBuyer({
  buyer_id_nr: '010101',
  product_name: 'Balance',
  buyer_name: 'Fatih',
  buyer_surname: 'Akdoğan',
  buyer_email: 'mail@mail.com',
  buyer_phone: '05555555555'
});
Set buyer's billing address.
shopier.setOrderBilling({
  billing_address: 'Kennedy Caddesi No:2592',
  billing_city: 'Istanbul',
  billing_country: 'Türkiye',
  billing_postcode: '34000'
});
Set buyer's shipping address.
shopier.setOrderShipping({
  shipping_address: 'Kennedy Caddesi No:2592',
  shipping_city: 'Istanbul',
  shipping_country: 'Türkiye',
  shipping_postcode: '34000'
});
How much will the customer pay?
For 15₺:
const paymentPage = shopier.generatePaymentHTML(15);

This will return the purchase form as html.

If we give an example for Express JS:
app.get('/pay', (req, res) => {
  res.end(paymentPage);
});

Now that we have render the html, a callback will be required after checkout.

app.post('/callback', (req, res) => {
  const callback = shopier.callback(req.body, 'apiSecret');
});
If payment was successful, it will return order_id, payment_id, installment.
{ order_id: 10592, payment_id: 413449826, installment: 0 }

Keywords

FAQs

Last updated on 09 Jan 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc