GEgetpaid
Authentication

Request access token

Obtain an OAuth 2.0 access token to authenticate API requests

post/oauth/token

Request

Request body

client_idstring required

Your OAuth client ID for the environment, live or sandbox, you are requesting the token for.

client_secretstring required

Your OAuth client Secret for the environment, live or sandbox, you are requesting the token for.

audience'https://api.sandbox.getpaid.io' | 'https://api.getpaid.io' uri required

The API you wish to integrate with. Use this to switch between sandbox and live environment.

grant_type'client_credentials' required

The OAuth grant type.

Example request

{
  "client_id": "g6gWu46zeP0HH4jkW3i22yJ2shDrNxJ8",
  "client_secret": "S6gozTXzrS42OZ0cmxVJG133mOfuHhSfkIJkcH7FBm-0HyGrVZMLGJtyruTA4CQv"
}

Response

OK

access_tokenstring required

The OAuth access token (JWT) used to authenticate to Getpaid API.

scopestring required

The API scopes granted to the access token.

expires_ininteger required

The duration (in seconds) until the access token expires.

token_type'Bearer' required

The type of token returned.

Example response

{
  "access_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "scope": "accounts:read documents:read_write payments:read",
  "expires_in": 86400
}

Changes

No recorded changes to this operation across all 1 revision of this API.