ALalternativepayments
OAuth

Get OAuth2 access token

OAuth2 client credentials flow endpoint. Generate a new access token using client credentials. The "client_id" (username) and "client_secret" (password) must be passed as Basic Auth credentials. Ex: Authorization: Basic Base64Encode(client_id:client_secret). The returned access token should be used as Bearer token for subsequent API calls: Authorization: Bearer {access_token}

post/oauth/token

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/oauth/token
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

grant_typestring required

OAuth2 grant type - must be 'client_credentials'

Response

Successfully generated OAuth2 access token

access_tokenstring

@Description The OAuth2 access token for API authentication - use as Bearer token in Authorization header @Example 580defdbe1d21e0001c67e5c2a0a6c98ba8b4a059dc5825388501574

expires_ininteger

@Description Token expiration time in seconds from issuance @Example 3600

token_typestring

@Description OAuth2 token type - always "bearer" for this implementation @Example bearer

Example response

{
  "access_token": "580defdbe1d21e0001c67e5c2a0a6c98ba8b4a059dc5825388501574",
  "expires_in": 3600,
  "token_type": "bearer"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.