---
title: "Configuring Square as a payment provider"
slug: "configuring-square-as-a-payment-provider"
tags: ["api", "platform", "config api", "tutorial", "payment", "payment options", "Square", "checkout", "NewStore checkout", "Associate App"]
updated: 2024-11-14T05:50:57Z
published: 2024-11-14T05:50:57Z
canonical: "docs.newstore.com/configuring-square-as-a-payment-provider"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.newstore.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/v1/docs/integrating-square#integ-square).

## Setting up Square credentials

- Use [Square Secrets API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_api#operation/putCredentials) to specify the following values:

| Feature/Property | Configuration setting |
| --- | --- |
| `application_id` | The Square application ID provided by the retailer, for the [Square PSP API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_api). |
| `access_token` | The access token provided by the retailer, for the [Square PSP API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_api). |

> [!TIP]
> Note
> 
> To view how the application ID and the access token is generated, see [Configuring the Square API](/v1/docs/integrating-square#configuring-the-square-api).
- Use the [Update Square signature key API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_api#operation/postSignatureKey) 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. |

> [!TIP]
> Note
> 
> To view how the signature key for Square is generated, see [Configuring notifications from Square](/v1/docs/integrating-square#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](https://docs.newstore.net/api/configuration/payment/payment_config_api#operation/getPSPSquareConfiguration) method.
2. Specify the following value in `api`:

| Feature/Property | Configuration setting |
| --- | --- |
| `base_url` | The URL for the [Square PSP API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_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](https://docs.newstore.net/api/configuration/payment/payment_config_api#operation/putPSPSquareConfiguration) method.

## Activating the Square integration

1. Retrieve the current provider configuration using the [Get FAT PSP configuration](https://docs.newstore.net/api/configuration/payment/payment_config_api#operation/getFATPSPConfiguration) 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](/v1/docs/configuring-payment-options#config-payment-options).
4. Use the [Update FAT PSP configuration](https://docs.newstore.net/api/configuration/payment/payment_config_api#operation/putFATPSPConfiguration) method to apply the updated configuration.

**Related topics**

- [Integrating a payment service provider](/v1/docs/integrating-a-payment-service-provider#integ-psp)
- [Integrating Adyen](/v1/docs/integrating-adyen#integ-adyen)
- [Integrating a gift card provider](/v1/docs/integrating-a-gift-card-provider#integ-giftcard)
- [Square PSP API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_api)
- [Square Secrets API](https://docs.newstore.net/private-api/payments/psp_square_aadmin)
- [Update Square signature key API](https://docs.newstore.net/api/configuration/payment/psp_square_configuration_api#operation/postSignatureKey)