Skip to main content
API docs by Redocly

Square credentials API (0)

Download OpenAPI specification:Download

This API will be used tools to configure and administer the square credentials

Update the Square credentials (application ID and access token)

Update the application ID used by the Square payment App. See Square documentation

Update the access token used to authenticate with the Square API via OAuth2 flow. See Square documentation

Request Body schema: application/json
access_token
required
string non-empty

The access_token as defined in the Square developer portal.

application_id
required
string non-empty

The application ID as defined in the Square developer portal.

Responses

Request samples

Content type
application/json
{
  • "application_id": "an_ID_generated_by_Square",
  • "access_token": "some_access_token_generated_by_Square"
}

Update the Square signature key

Update the signature key used by the Square webhook notifications to calculate the HMAC-SHA1 signature. See square documentation

Authorizations:
newStoreAccessToken
Request Body schema: application/json
signature_key
required
string non-empty

The signature token as defined in the Square developer portal.

Responses

Request samples

Content type
application/json
{
  • "signature_key": "the_signature_key_generated_by_Square"
}