StellarCheckout
An open source javascript plug-in for the stellar.org blockchain.
https://www.stellarcheckout.com/demo
Installation
npm i --save-dev stellar-checkout
CDN
<script type="text/javascript" src="https://unpkg.com/stellar-checkout/stellar-checkout.min.js"></script>
NOTE: Use a specific version when loading via CDN. The latest version may contain breaking changes.
HTTPS
You must serve the script over HTTPS to use Ledger Wallet. Ledger wallet uses U2F which will fail without HTTPS.
Features
- Send & receive payments in Lumens (XLM)
- Responsive, Skinnable UI
- Currency conversion support for 32 fiat currencies
- Federation client
- Ledger Wallet integration
- Multiple networks (test, public and custom)
- Simple integration options
- Demos & Documentation (WIP)
- Open source
- Available via NPM and CDN
Options
{
amount: {
type: Decimal,
required: false
},
culture: {
type: String,
required: false,
default: 'en',
options: [
'en'
]
},
currency: {
type: String,
required: false,
default: 'USD',
options: ["AUD", "BRL", "CAD", "CHF", "CLP", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD", "THB", "TRY", "TWD", "ZAR"]
},
id: {
type: String,
required: false
},
network: {
type: String,
required: false,
default: 'test',
options: [ 'custom', 'public', 'test' ]
},
networkUri: {
type: String,
required: [network] === 'custom'
},
networkPassphrase: {
type: String,
required: [network] === 'custom'
},
onSubmit: {
type: function,
required: false
},
redirectUrl: {
type: String,
required: false
},
showNetworkSelector: {
type: Boolean,
required: false
},
showTicker: {
type: Boolean,
required: false
},
stylesheet: {
type: String,
required: false
}
}
Reference
https://brewaa.github.io/stellar-checkout/reference/index.html
Demo
https://brewaa.github.io/stellar-checkout/demo/index.html
Demo (web site integrated)
https://www.stellarcheckout.com/demo
Basic Example
See Basic Configuration Example in the wiki.
<div id="elem"></div>
<script type="text/javascript" src="https://unpkg.com/stellar-checkout/stellar-checkout.min.js"></script>
<script>
StellarCheckout.render('#elem', {
amount: '10',
currency: 'GBP',
to: 'GBBADTX7GN4ENDZ55HIFEBSZH4NSKWABTM7LRX7AFZW3SZXULHTKB7XI'
});
</script>
Wiki
More examples can be found in the wiki. View Examples
3rd Party Services
This plug-in uses the StellarCheckout.com API.
- Browse the API explorer for a list of end points - https://www.stellarcheckout.com/swagger/
- View the stellarcheckout.com source - https://github.com/brewaa/stellarcheckout.com
Payment Verification
Additional verification should be implemented on the server. The only way this can be achieved is by using the submit handler. The submit handler will dump the entire $state of the application at the time the transaction was processed. This data should be saved server side and verified independently.
Disclaimer
StellarCheckout is not affiliated with nor endorsed by the Stellar Development Foundation. StellarCheckout is an independent open source contribution to the Stellar network.
Tip Jar
XLM: GBBADTX7GN4ENDZ55HIFEBSZH4NSKWABTM7LRX7AFZW3SZXULHTKB7XI