Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

flow-stripe-component

FlowAppPlatform7Apache-2.00.1.5

Stripe components designed to work with Flow SDK

stripe, flow

readme

Flow Stripe component

The component is designed using Flow SDK and implements Stripe's features.

To get started, install the package in your NodeJS project

npm i flow-stripe-component --save

Use the component as below

// require the component
const Component = require('flow-stripe-component');

// create instance of the Charge component for example
const component = new Component.Charge();

Provide stripe secret key

// this is routed to Stripe right away, we never store these
component.getProperty('secret_key').data = 'Your_Stripe_Secret_Key';

Provide card details

// this is a test card, be sure to use your own
component.getProperty('card_number').data = '4242424242424242';
component.getProperty('cvc').data = '123';
component.getProperty('expiry_month').data = 11;
component.getProperty('expiry_year').data = 2021;

Provide charge details

// this is required for the Charge component
component.getProperty('currency').data = 'usd';
component.getProperty('amount').data = 100;

Listen in for port emit events

component.getPort('Success').onEmit(function(){
  // the charge was made
  // the server response can be accessed through the 'Data' property of the port
  let response = component.getPort('Success').getProperty('Data').data;
});

component.getPort('Error').onEmit(function(){
  // an error occured
  // the actual error can be accessed through the 'Data' property of the port
  let err = component.getPort('Error').getProperty('Data').data;
});

Execute the component

// add the component to a graph before executing it
const Graph = require('flow-platform-sdk').Graph;
new Graph("graph-1").addComponent(component);

component.execute();

Conclusion

That's the Flow Stripe component.

If you are having trouble making charges,

  • Check that you are using the correct card details
  • Be sure your Stripe secret key is right.