Feature

Stripe Integration Plugin

Marketplace Product

Stripe Integration plugin enables secure processing of credit card transactions using Stripe. Additionally, the plugin can update the app about the status of the transaction, which is handled through an asynchronous callback.

Stripe Integration Plugin

The product integrates the Stripe service with Backendless to enable secure credit card processing and transaction status notification. Using Stripe Integration plugin developers can enjoy the simplicity of transaction processing by Stripe with the security and reliability of the Backendless servers. With the power of real-time messaging and real-time database, Backendless apps instantly get a notification when Stripe finishes transaction processing so the end user can be notified without waiting.

The Stripe integration plugin enables server-side validation and callback handling for payments processed by Stripe. The overall flow of the Backendless/Stripe integration can be seen in the diagram below:

Stripe Integration with Backendless
  1. Client app sends credit card data to the Stripe servers using the Stripe SDK.
  2. If the data is valid, the app gets a response with a one-time token, otherwise it will get an error.
  3. The client app sends the token and the amount to charge to the Backendless servers using the POST /Stripe/charge route.
  4. Backendless sends a request containing transaction data (the amount) and the client’s token to Stripe along with a secret key which exists only on the Backendless servers.
  5. If the secret key, transaction data (the amount) and token are valid, Stripe begins transaction processing and returns the info about current transaction back to Backendless:
    Stripe transaction info
  6. Backendless sends the transaction info to the client app.
  7. Once Stripe finishes the processing of the transaction, it executes a callback (a webhook) to Backendless. The callback contains the information about the transaction status. The information is stored in the Backendless Database (the StripeEvents table). Additionally, Backendless publishes the information into a messaging channel. The client app can subscribe to an event using Backendless Real-Time Messaging (channel: stripe/<transaction-id>). When it receives a message with the transaction status, the app can inform the user that the transaction has been completed.

There are a few things to note:

  • Steps 1 and 2 are request/response operations for a request from web/mobile client to the Stripe servers.
  • Steps 3, 4, 5 and 6 are executed as a part of the same workflow where Backendless acts as a proxy between the web/mobile client and Stripe. The importance of Backendless here is it adds a secret key to the request sent to Stripe.

Installation Instructions

  1. Login to Backendless Console and select your app. Open the Marketplace screen and install the “Stripe Integration plugin” from the Backendless marketplace. The plugin product is available under the All services menu. The product itself is available at no cost (free), however, keep in mind that your app must be on a paid plan in order to install a product from the Marketplace.
  2. The Stripe Integration plugin product has required configuration parameters. When installing the product, you will be presented with a configuration popup window shown below. Keep the browser window open as you will return to it with the required information.
    Stripe integration configuration
  3. Open a new browser window and navigate to Stripe’s website. Register/login to your account.
  4. Open the Stripe developer console and navigate to Developers > Webhooks. Click the + Add endpoint button in the “Endpoints receiving events from your account” section. Add the URL in the following format:
    https://api.backendless.com/<APP-ID>/<API-KEY>/services/Stripe/webhooks/handler
    where:
    <APP-ID> is your Backendless application ID
    <API-KEY> is the REST API Key.
    Both values can be obtained from the main dashboard of Backendless console. Since the other browser window is left open where you were installing the product from the marketplace, you can open an additional browser window/tab to obtain these two values for the URL.
    Enter the URL into the field shown in the screenshot below:
    Stripe API webhook enpoint
  5. Select the created webhook endpoint, click the Click to reveal button and copy the Signing secret:
    Stripe Signing Secret
  6. Return to Backendless console where the Stripe Integration product is being installed and paste Signing secret from the previous step into the Signing secret field.
  7. Make sure to enter a value for the Currency field.
  8. The values for the Secret key and the Publishable key fields should also be obtained from Stripe console as shown below (see the Developers > API keys section):
    Stripe Keys
  9. Click the ACTIVATE button to finalize the installation of the product from the Marketplace. The service is now ready to process your transactions.

Webhooks and Stripe Events

When a webhook is registered with Stripe, the Stripe Integration plugin processes Stripe events and performs the following actions:

  1. Saves event data in the Backendless Database
  2. Publishes a pub/sub message (via real-time messaging) with event information.

Events in the database are stored in the StripeEvents table. The table has the following schema (you do not need to create it manually unless the Dynamic Schema Definition option is disabled):

StripeEvents Table Schema

where:

  • The id column contains the id of the transaction.
  • The type column contains the event type.

The screenshot below shows sample contents of the data table:

Stripe Events Sample Data

Additionally, the plugin implementation sends out the payload of the event through Backendless Real-Time Messaging. To receive the messages, the client application must subscribe to the stripe messaging channel. To receive a message for a specific transaction, the following selector must be used:

id = 'transaction id'

For example,

id = 'ch_1Cmms9I56A1133zjexAcwndb'

The transaction id can be obtained from the response object received for the “Initiating a charge” API call documented below.

Supported API

The Stripe Integration plugin provides the following APIs:

Initiating a Charge

This is the API which is used in step 3 in the diagram above:

    Backendless.initApp( "YOUR-APP-ID", "ANDROID-API-KEY" );
    
    float amount = AMOUNT-TO-CHARGE;
    HashMap<String, Object> params = new HashMap<String,Object>();
    params.put( "token", TOKEN-VALUE-FROM-STRIPE );
    params.put( "amount", amount );
    Object[] args = new Object[]{ params };
    Backendless.CustomService.invoke( "Stripe", "charge", args, Object.class,
      new AsyncCallback<Object>()
      {
        @java.lang.Override
        public void handleResponse( Object response )
        {
          Log.info( "MYAPP", "Charge has been submitted" );
    
          // to get a real-time message:
          HashMap responseHash = (HashMap) response;
          String txId = (String) responseHash.get("id");
          Channel channel = Backendless.Messaging.subscribe("stripe");
          channel.addMessageListener("id = '" + txId + "'", new AsyncCallback<HashMap>() {
            @Override
            public void handleResponse(HashMap response) {
                Log.i( "MYAPP", "got webhook callback " + response );
            }
    
            @Override
            public void handleFault(BackendlessFault fault) {
                Log.e( "MYAPP", "got error " + fault.toString() );
    
            }
        }, HashMap.class );}
    
        @java.lang.Override
        public void handleFault( BackendlessFault fault )
        {
          Log.error( "MYAPP", "Server returned an error " + fault );
        }
      });

    Backendless.initApp( YOUR-APP-ID, YOUR-JS-API-KEY );
    
    var chargeData = { 
      token: TOKEN-VALUE-FROM-STRIPE,
      amount: AMOUNT-TO-CHARGE
    }
    
    Backendless.CustomServices.invokeSync( "Stripe", "charge", [ chargeData ] )
      .then( function( result ) {
        // result.id provides transaction id
      })
      .catch( function( error ) {
      });

    curl -X "POST" "https://api.backendless.com/<API-ID>/<API-KEY>/services/Stripe/charge" \
        -H 'Content-Type: application/json' \
        -H 'Accept: application/json' \
        -d $'{
    "amount" : <amount>,
    "token" : <token> 
    }'