Authentication

Please contact [e-mail] to acquire your authentication credentials.

Login

POST/Auth/login

Authorization

oauth2

Header parameters

Body

application/jsontext/jsonapplication/*+json

usernamenullable string

passwordnullable string

Response

200400

Success

Body

text/plainapplication/jsontext/json

idTokennullable string

expiresInSecondsinteger (int32)

refreshTokennullable string

Request

JavaScriptCurlPython

const response = await fetch('/Auth/login', {
    method: 'POST',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "idToken": "text",
  "refreshToken": "text"
}

Users with different roles can be authenticated using this endpoint. For the most part, integrators will be authenticating on behalf of a Terminal. In this case, the username will be {terminalId}@beadpay.io and the password will be the terminal's password.

The API will respond with the OAuth 2.0 JSON Web Token (JWT) bearer token which should be used in all subsequent calls to API.

The token is valid for 1 hour and needs to be refreshed before it expires using the Refresh Token endpoint.

To access protected endpoints, after receiving the JWT token, pass it as a bearer token in the Authorization header of the request.

Example API call using curl:

curl -X 'POST' \
  'https://api.qa.devs.beadpay.io/auth/refresh-token' \
  -H '' \
  -H 'Content-Type: application/json' \
  -d '{
  "refreshToken": "{refresh_token}"
}'

Refresh Token

POST/Auth/refresh-token

Authorization

oauth2

Header parameters

Body

application/jsontext/jsonapplication/*+json

refreshTokennullable string

Response

200400401403

Success

Body

text/plainapplication/jsontext/json

idTokennullable string

expiresInSecondsinteger (int32)

refreshTokennullable string

Request

JavaScriptCurlPython

const response = await fetch('/Auth/refresh-token', {
    method: 'POST',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "idToken": "text",
  "refreshToken": "text"
}

Note that this endpoint is protected and you need to pass JWT token in the Authorization header to access it.