Integration with Stripe
Copy the link to the article
Copied

Contents

  1. Overview
  2. Configure the integration
  3. Payment types and invoice statuses
  4. Work with Stripe in an order

Overview

Stripe is a service for managing online payments.

The integration lets you generate payment links through Stripe. When an invoice is paid, the payment status changes automatically in Simla. You can also issue a refund from the order. The link can be sent by SMS or email, copied to a chat, or shared through another messaging service.

The integration is available if at least one of the following countries is enabled: Spain, Peru, the United States, Chile, the United Kingdom, Mexico, Bolivia, Japan, Germany, Colombia, Ecuador, Argentina, India, Brazil, Portugal, China, or the United Arab Emirates.

Important!

The currency configured in Stripe must match the currency selected in Simla.

Configure the integration

Prerequisites

To connect Stripe, you need a verified Stripe account. Complete the company, bank, and other details required by the service.

The account can be connected to Simla after the contract has been signed and the live account has been activated.

Create an API key in Simla

Before connecting Stripe, open your Simla account, for example, https://yourstore.simla.com, and go to Settings → Integration → API access keys. Create an application programming interface (API) key, select the store, and enable the following methods:

Integration:

  • /api/integration-modules/{code}
  • /api/integration-modules/{code}/edit

Payments:

  • /api/payment/(updateInvoice|check)

API key permissions for integration modules and payments in Simla

Connect and configure a Stripe account

In the Simla Marketplace, select Stripe and click Connect. On the connection page, enter your Simla account URL and the API key created earlier.

Open the Accounts section and enter the Publishable Key and Secret Key to add an account.

Stripe account form with Publishable Key and Secret Key fields

Note

The Publishable Key and Secret Key are available in Stripe under Developers → API keys.

Publishable Key and Secret Key in the Stripe API keys section

After entering the keys, click Save. The updated page displays the connected account, store name, and Confirm manually option.

The Confirm manually option lets you confirm or reject each payment from the order and helps prevent accepting a payment that would then need to be refunded.

Note

If Confirm manually is disabled, payments are accepted automatically. To cancel an accepted payment, you must issue a refund.

The Test field is configured through Stripe and indicates whether the connected account is for testing or production.

Below the connected accounts table, a link opens the payment type settings in Simla.

Connected Stripe account with the Test and Confirm manually settings

Payment types and invoice statuses

For every store connected in Stripe, Simla automatically creates a payment type with default settings. You do not need to create it manually. If necessary, edit it under Settings → Data books → Payment types.

Stripe payment type in the Simla data books

The invoice statuses also receive a default mapping. If statuses have already been configured for another payment integration, the same settings are applied to later integrations. The mapping can be edited when necessary.

Click Configure in the Invoice statuses section to open the status mapping window.

Invoice status mapping window for the Stripe payment type

If the existing statuses do not match the company's process, select the status to map, click Add new payment status, enter a name, and confirm it using the green checkmark icon.

Statuses created from this window are also available in the Payment statuses section.

Work with Stripe in an order

After the integration is configured, the Stripe payment type is available in the Payments block of the order.

Stripe payment in an order with the Generate link action

Generate and send a payment link

After saving the order, you can generate a payment link. The following information and actions are then displayed:

  • Link to pay: can be copied and sent to the customer in a chat.
  • Send to email: sends the link to the email address specified in the order.
  • Sum: total amount to be paid.
  • Creation date: date when the link was generated.
  • Invoice status: updates automatically when the payment is completed.
  • Cancel: cancels the link.
  • Status: updates automatically according to the configured status mapping.
  • Paid date: date when the payment was completed.

Generated Stripe payment link awaiting manual confirmation

Complete a payment and issue a refund

When the customer opens the link, Stripe displays its secure payment page.

Stripe payment page with card and Google Pay options

After a successful payment, its status is updated in the order according to the configured mapping. The Sum and Paid date fields also show the updated data.

To issue a refund, click Obtain a refund in the order.

Obtain a refund button for a completed Stripe payment

After the refund is confirmed, the payment status is updated automatically.

Stripe payment with a successfully completed refund

Thank you for your feedback.
Was this article helpful?
No
  • Рекомендации не помогли
  • Нет ответа на мой вопрос
  • Текст трудно понять
  • Не нравится описанный функционал
Yes
Next article
Integration with PayPal
How to connect PayPal to Simla, configure payment types and statuses, generate payment links, and manage confirmations and refunds.