Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.65 KB

obtain-token-response.md

File metadata and controls

36 lines (28 loc) · 2.65 KB

Obtain Token Response

Structure

Obtain Token Response

Fields

Name Type Tags Description
access_token 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
token_type String Optional This value is always bearer.
Constraints: Minimum Length: 2, Maximum Length: 10
expires_at String Optional The date when the access_token expires, in ISO 8601 format.
Constraints: Minimum Length: 20, Maximum Length: 48
merchant_id String Optional The ID of the authorizing merchant's business.
Constraints: Minimum Length: 8, Maximum Length: 191
subscription_id 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.
plan_id 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.
id_token String Optional The OpenID token belonging to this person. This token is only present if the
OPENID scope is included in the authorization request.
refresh_token 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
short_lived TrueClass | FalseClass 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 Array<Error Hash> Optional Any errors that occurred during the request.
refresh_token_expires_at String 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"
}