Square

Medusa Square Payment

What is it?

Medusa Square Payment is a basic integration of payment provider for Square Payment.

Installation

1. Install plugin by adding to your package.json:

Warning

1...
2"@rsc-labs/medusa-square-payment": "0.0.1" // or other available version
3...

and execute install, e.g. yarn install.

1. Add plugin to your medusa-config.js (Note - please notice that you need to add it to payment plugin):

1...
2  plugins: [
3    {
4      resolve: "@rsc-labs/medusa-square-payment",
5      options: {
6        token: <app-token>,
7        environment: <env-definition>,
8      },
9    }
10  ],
11  modules: [
12    {
13      resolve: "@medusajs/medusa/payment",
14      options: {
15        providers: [
16          {
17            resolve: "@rsc-labs/medusa-square-payment/providers/square-payment",
18            id: "square-payment",
19            options: {
20              token: <app-token>,
21              environment: <env-definition>,
22            },
23          }
24        ]
25      },
26    },
27...

Overview

The basic implementation of Square payment provider gives the possibility to make a payment in your storefront.

Configuration

Plugin uses 1 required parameter and 1 optional:

• token - required parameter which you can find in your Square Developer Dashboard
• environment - optional parameter - it can be set to sandbox, production or not set at all. You can use it to test with your sandbox environment.

After above configuration, you can then add the payment provider to your reqion.

Storefront

We recommend using react-square-web-payments-sdk package on your storefront as it simplifies the implementation a lot. Here is the example of using credit card as payment:

1import { PaymentForm, CreditCard as SquareCreditCard } from 'react-square-web-payments-sdk';
2...
3
4const handleSquareSubmit = async (token: string) => {
5    setIsLoading(true)
6    try {
7      if (!activeSession) {
8        await initiatePaymentSession(cart, 
9          {
10            provider_id: selectedPaymentMethod,
11            data: {
12              cartId: cart?.id,
13              token: token
14            }
15          })
16      }
17
18      return router.push(
19        pathname + "?" + createQueryString("step", "review"),
20        {
21          scroll: false,
22        }
23      )
24    } catch (err: any) {
25      setError(err.message)
26    } finally {
27      setIsLoading(false)
28    }
29  }
30{isSquare(selectedPaymentMethod) &&
31  <div>
32    <PaymentForm
33      applicationId="<application-id>"
34      cardTokenizeResponseReceived={(token, verifiedBuyer) => {
35        handleSquareSubmit(token.token!);
36      }}
37      locationId='XXXXXXXXXX'
38    >
39      <SquareCreditCard/>
40    </PaymentForm>
41  </div>
42}

<application-id> - you can retrieve it from your Square Developer Dashboard.

Limitations

Plugin does not support refunds and cancels. It has been tested using only credit card - when authorized, it captures money automatically.

License

MIT

© 2025 RSC https://rsoftcon.com/