You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP

react-coinbase-commerce-modal

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-coinbase-commerce-modal

A react component to easily embed a Coinbase Commerce Checkout within your application... but just the modal

1.3.2
latest
Version published
Maintainers
1
Created

CircleCI npm version

Coinbase Commerce React Modal

A modal to embed a Coinbase Commerce checkout or charge directly into your React application.

npm i -S react-coinbase-commerce-modal

Features

  • Connect your Coinbase Commerce account to easily accept cryptocurrencies from within your application.
  • Support for embedding individual charges or entire checkouts
  • Callback APIs for successful and failed payments.
  • No API key required

Table of Contents

Usage

import CoinbaseCommerceModal from 'react-coinbase-commerce-modal';

const App = () => {
  return (
    <CoinbaseCommerceModal checkoutId={'My checkout ID'} showModal={!!showMyModal}/>
  )
};

Getting Started

  • To start accepting digital currency payments, first register for a Coinbase Commerce account here.
  • Whitelist your domain in Settings.
  • Follow the API Documentation here to create a charge or checkout.
    • Alternatively, create a checkout from the merchant dashboard and copy the ID found in the checkout's details.
  • Pass the ID of the charge or checkout you create to the CoinbaseCommerceModal component
  • That's it! You're ready to start accepting digital currency payments with Coinbase Commerce

Docs

Props

Prop Namedefaultrequiredtype
showModalfalsenoboolean
styledfalsenoboolean
checkoutIdnilIf no chargeId, yesstring
chargeIdnilIf no checkoutId, yesstring
onLoadnilno()=>void
onChargeSuccessnilno(MessageData)=>void
onChargeFailurenilno(MessageData)=>void
onPaymentDetectednilno(MessageData)=>void
onModalClosednilno()=>void
disableCachingfalsenoboolean
customMetadatanilnostring

Warning: If disableCaching is set to true, users that accidentally close their payment windows will be unable to see their transaction's status upon reopening.

Data Types

type MessageData = {
  event: 'charge_confirmed' | 'charge_failed' 'payment_detected',
  code: <CHARGE_CODE>
}

FAQs

Package last updated on 22 Jan 2019

Did you know?

Socket

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