Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 2 KB

obtain-token-response.md

File metadata and controls

31 lines (24 loc) · 2 KB

Obtain Token Response

Structure

ObtainTokenResponse

Fields

Name Type Tags Description Getter
AccessToken String Optional A valid OAuth access token. OAuth access tokens are 64 bytes long.
Provide the access token in a header with every request to Connect API
endpoints. See the Build with OAuth guide
for more information.		 String getAccessToken()
TokenType String Optional This value is always bearer. String getTokenType()
ExpiresAt String Optional The date when access_token expires, in ISO 8601 format. String getExpiresAt()
MerchantId String Optional The ID of the authorizing merchant's business. String getMerchantId()
SubscriptionId String Optional LEGACY FIELD. The ID of a subscription plan the merchant signed up
for. Only present if the merchant signed up for a subscription during authorization.		 String getSubscriptionId()
PlanId String Optional T__LEGACY FIELD__. The ID of the subscription plan the merchant signed
up for. Only present if the merchant signed up for a subscription during
authorization.		 String getPlanId()
IdToken String Optional Then OpenID token belonging to this this person. Only present if the
OPENID scope is included in the authorize request.		 String getIdToken()
RefreshToken String Optional A refresh token. OAuth refresh tokens are 64 bytes long.
For more information, see OAuth access token management.		 String getRefreshToken()

Example (as JSON)

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