• postUpdate the Square access token
• postUpdate the Square signature key
• postUpdate the Square application ID

API docs by Redocly

Square configuration and administration API (0)

Download OpenAPI specification:Download

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

Update the Square access token

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.

Responses

/_/v1/org/psps/square/credentials/access_token

Request samples

• Payload

Content type

application/json

{

• "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

/_/v1/org/psps/square/credentials/signature_key

Request samples

• Payload

Content type

application/json

{

• "signature_key": "the_signature_key_generated_by_Square"

}

Update the Square application ID

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

Request Body schema: application/json

application_id required

string non-empty The application ID as defined in the Square developer portal.

Responses

/_/v1/org/psps/square/credentials/application_id

Request samples

• Payload

Content type

application/json

{

• "application_id": "some_ID_generated_by_Square"

}