Configuring Square as a payment provider

NewStore partners with Square as the payment service provider (PSP). Square is the payment provider for retailers with stores in Japan, where Adyen does not yet support in-store payments.

To set up Square with NewStore, see the integration guide.

Setting up Square credentials

• Use Square Secrets API to specify the following values:

  Feature/Property	Configuration setting
  application_id	The Square application ID provided by the retailer, for the Square PSP API.
  access_token	The access token provided by the retailer, for the Square PSP API.

  Note

  To view how the application ID and the access token is generated, see Configuring the Square API.

• Use the Update Square signature key API to update the signature key of the Square webhooks provided by the retailer:

  Feature/Property	Configuration setting
  signature_key	Signature key of the Square webhooks provided by the retailer.

  Note

  To view how the signature key for Square is generated, see Configuring notifications from Square.

Setting up NewStore to connect with Square

To configure Square and add related values in NewStore for the PSP:

1. Retrieve the current Square configuration using the Get PSP Square configuration method.

2. Specify the following value in api:

   Feature/Property	Configuration setting
   base_url	The URL for the Square PSP API: https://connect.squareup.com/v2/.

3. Add an item to the list for each NewStore store that will support Square payments in store_mapping:

   Feature/Property	Configuration setting
   location_id	The location ID provided by the retailer.
   store_id	The NewStore store ID.

4. Apply the updated configuration using the Update PSP Square configuration method.

Activating the Square integration

1. Retrieve the current provider configuration using the Get FAT PSP configuration method.

2. Add a square item with the following values to the internal_providers property:

   Feature/Property	Configuration setting
   endpoint	Specify /psp_square.PSPSquare/Execute.
   protocol	Specify grpc.

3. Add Square as a payment option to specific stores, where Square POS will be used to accept card and wallet payments. For more information, see Configuring payment options.

4. Use the Update FAT PSP configuration method to apply the updated configuration.

Related topics

• Integrating a payment service provider

• Integrating Adyen

• Integrating a gift card provider

• Square PSP API

• Square Secrets API

• Update Square signature key API