Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 3.4 KB

obtain-token-response.md

File metadata and controls

36 lines (28 loc) · 3.4 KB
Raw

Obtain Token Response

Structure

ObtainTokenResponse

Fields

Name Type Tags Description Getter Setter
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		 getAccessToken(): ?string setAccessToken(?string accessToken): void
tokenType ?string Optional This value is always bearer.
Constraints: Minimum Length: 2, Maximum Length: 10		 getTokenType(): ?string setTokenType(?string tokenType): void
expiresAt ?string Optional The date when the access_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48		 getExpiresAt(): ?string setExpiresAt(?string expiresAt): void
merchantId ?string Optional The ID of the authorizing merchant's business.
Constraints: Minimum Length: 8, Maximum Length: 191		 getMerchantId(): ?string setMerchantId(?string merchantId): void
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.		 getSubscriptionId(): ?string setSubscriptionId(?string subscriptionId): void
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.		 getPlanId(): ?string setPlanId(?string planId): void
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.		 getIdToken(): ?string setIdToken(?string idToken): void
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		 getRefreshToken(): ?string setRefreshToken(?string refreshToken): void
shortLived ?bool 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.		 getShortLived(): ?bool setShortLived(?bool shortLived): void
errors ?(Error[]) Optional Any errors that occurred during the request. getErrors(): ?array setErrors(?array errors): void
refreshTokenExpiresAt ?string Optional The date when the refresh_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48		 getRefreshTokenExpiresAt(): ?string setRefreshTokenExpiresAt(?string refreshTokenExpiresAt): void

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