Authentication

We use the industry-standard oAuth2 authentication to secure our API.

Information you'll need

Your Client ID and Client Secret (from the application you created in Fuzebox).
Your API username and password (from the merchant credentials section in Fuzebox).

Step-by-step instructions on how to authenticate are available in our integration guides area.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

grant_type*string

Grant type must be password.

Value in"password"

client_id*string

Client identifier from the application created in Fuzebox.

Formatuuid

client_secret*string

Client secret from the application created in Fuzebox.

Formatuuid

username*string

API username from customer credentials created in Fuzebox.

password*string

API password from customer credentials created in Fuzebox.

Response Body

`application/json`

curl -X POST "https://gateway.sandbox.volt.io/oauth" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "password",
    "client_id": "59280aee-6efd-48c2-b85a-7c315b885374",
    "client_secret": "384f286f-4e89-4c93-b1d0-41f288fbc00c",
    "username": "dummy-username",
    "password": "randomgeneratedpassword"
  }'

curl -X POST "https://gateway.sandbox.volt.io/oauth" \  -H "Content-Type: application/json" \  -d '{    "grant_type": "password",    "client_id": "59280aee-6efd-48c2-b85a-7c315b885374",    "client_secret": "384f286f-4e89-4c93-b1d0-41f288fbc00c",    "username": "dummy-username",    "password": "randomgeneratedpassword"  }'

{
  "access_token": "eyJ0eXAiOi...",
  "token_type": "Bearer",
  "expires_in": 86400,
  "refresh_token": "50679c5db61d63b107273fa11a666a09fc7ae28"
}

{
  "code": 401,
  "message": "Bad credentials, please verify your credentials are correctly set"
}

Authentication

Information you'll need

Request Body

Response Body

200application/json

401application/json

`application/json`

`application/json`