Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.75 KB

obtain-token-response.md

File metadata and controls

36 lines (28 loc) · 2.75 KB
Raw

Obtain Token Response

Structure

ObtainTokenResponse

Fields

Name Type Tags Description
accessToken string | undefined Optional A valid OAuth access token.
Provide the access token in a header with every request to Connect API
endpoints. For more information, see OAuth API: Walkthrough.
Constraints: Minimum Length: 2, Maximum Length: 1024
tokenType string | undefined Optional This value is always bearer.
Constraints: Minimum Length: 2, Maximum Length: 10
expiresAt string | undefined Optional The date when the access_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48
merchantId string | undefined Optional The ID of the authorizing merchant's business.
Constraints: Minimum Length: 8, Maximum Length: 191
subscriptionId string | undefined Optional LEGACY FIELD. The ID of a subscription plan the merchant signed up
for. The ID is only present if the merchant signed up for a subscription plan during authorization.
planId string | undefined Optional LEGACY FIELD. The ID of the subscription plan the merchant signed
up for. The ID is only present if the merchant signed up for a subscription plan during
authorization.
idToken string | undefined Optional The OpenID token belonging to this person. This token is only present if the
OPENID scope is included in the authorization request.
refreshToken string | undefined Optional A refresh token.
For more information, see Refresh, Revoke, and Limit the Scope of OAuth Tokens.
Constraints: Minimum Length: 2, Maximum Length: 1024
shortLived boolean | undefined Optional A Boolean indicating that the access token is a short-lived access token.
The short-lived access token returned in the response expires in 24 hours.
errors Error[] | undefined Optional Any errors that occurred during the request.
refreshTokenExpiresAt string | undefined Optional The date when the refresh_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48

Example (as JSON)

{
  "access_token": "ACCESS_TOKEN",
  "expires_at": "2006-01-02T15:04:05Z",
  "merchant_id": "MERCHANT_ID",
  "refresh_token": "REFRESH_TOKEN",
  "token_type": "bearer",
  "subscription_id": "subscription_id8"
}