wbf

@satispay/web-button-factory

This module is deprecated and it is no longer maintained. For migrating to a supported integration please check the [Satispay Business API documentation](https://developers.satispay.com/).

Showing:

Popularity

Downloads/wk

1

Maintenance

No Maintenance Data Available

Package

Dependencies

0

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Deprecated!
This module is deprecated and it is no longer maintained. For migrating to a supported integration please check the Satispay Business API documentation https://developers.satispay.com

Readme

WARNING

This module is deprecated and it is no longer maintained.
For migrating to a supported integration please check the Satispay Business API documentation.


This library is made for React, Angular and other frameworks.

Example

Create an iframe on document.body

import { IFrame } from '@satispay/web-button-factory'

const iframe = new IFrame({
  datakey: 'dk_...',
  userCallback: 'https://yourwebsite.ext/userCallback',
  amount: 100,
  description: 'Testing Charge',
})

Now with show() you can display the iframe

iframe.show()

IFrame

Methods

NameDescriptionArguments
on(event, function)Subscribe a function to an eventEvent name, Function
off(event)Unsubscribe eventEvent name
showShow the IFrame
hideHide the IFrame

Events

NameEmit onArguments
closeClose modal
loadIFrame is loaded
completed(chargeId)Charge success or failCharge ID

Properties

The IFrame constructor accept the following properties

NameTypeDescriptionMandatoryDefaultValues
onlineServicestringOnline service urlNohttps://online.satispay.com
datakeystringShop datakeyYes
userCallbackstringUser callback urlYes
amountnumberAmount in centsYes
descriptionstringDescription of chargeYes
orderIdstringID of order, passed to user callbackNo
phonenumberstringPhone number of userNo
currencystringCurrency, currently only EUR is availableNoeureur
localestringLanguageNoautoit, en
drawonstringWhere to draw the iframeNodocument.body

These properties are editable before show()

  • userCallback
  • amount
  • description
  • orderId
  • phonenumber
  • currency
  • locale

Button

The button function return an image url

NameTypeDescriptionMandatoryDefaultValues
onlineServicestringOnline service urlNohttps://online.satispay.com
localestringLanguageYesit, en
typestringType of buttonNopaypay, donate
colorstringColor of buttonNoredred, white

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100