retrieve-token-status-response.md

Retrieve Token Status Response

Defines the fields that are included in the response body of a request to the RetrieveTokenStatus endpoint

Structure

RetrieveTokenStatusResponse

Fields

Name	Type	Tags	Description
scopes	string[] | undefined	Optional	The list of scopes associated with an access token.
expiresAt	string | undefined	Optional	The date and time when the access_token expires, in RFC 3339 format. Empty if token never expires.
clientId	string | undefined	Optional	The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token. Constraints: Maximum Length: 191
merchantId	string | undefined	Optional	The ID of the authorizing merchant's business. Constraints: Minimum Length: 8, Maximum Length: 191
errors	Error[] | undefined	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "client_id": "CLIENT_ID",
  "expires_at": "2022-10-14T14:44:00Z",
  "merchant_id": "MERCHANT_ID",
  "scopes": [
    "PAYMENTS_READ",
    "PAYMENTS_WRITE"
  ]
}