Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.94 KB

obtain-token-response.md

File metadata and controls

36 lines (28 loc) · 2.94 KB
Raw

Obtain Token Response

Structure

ObtainTokenResponse

Fields

Name Type Tags Description Getter
AccessToken String 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		 String getAccessToken()
TokenType String Optional This value is always bearer.
Constraints: Minimum Length: 2, Maximum Length: 10		 String getTokenType()
ExpiresAt String Optional The date when the access_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48		 String getExpiresAt()
MerchantId String Optional The ID of the authorizing merchant's business.
Constraints: Minimum Length: 8, Maximum Length: 191		 String getMerchantId()
SubscriptionId String 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.		 String getSubscriptionId()
PlanId String 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.		 String getPlanId()
IdToken String Optional The OpenID token belonging to this person. This token is only present if the
OPENID scope is included in the authorization request.		 String getIdToken()
RefreshToken String Optional A refresh token.
For more information, see Refresh, Revoke, and Limit the Scope of OAuth Tokens.
Constraints: Minimum Length: 2, Maximum Length: 1024		 String getRefreshToken()
ShortLived Boolean 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.		 Boolean getShortLived()
Errors List<Error> Optional Any errors that occurred during the request. List getErrors()
RefreshTokenExpiresAt String Optional The date when the refresh_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48		 String getRefreshTokenExpiresAt()

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