API authentication
- As a merchant
- As a PSP
- As a TSP
To use the Volt API as a merchant you’ll need two sets of credentials to pass to our authentication endpoint and obtain an access token.
- One set is the
client_idandclient_secret, which tells us the application you’ve built to access the API.
- The other set of credentials is the
usernameandpasswordwhich allows your application to access your data during this API session.
Where to find your username and password
Your username and password are available in Fuzebox > Configuration > Customers
To use the Volt API as a Payment Service Provider (PSP) you’ll need two sets of credentials to pass to our authentication endpoint and obtain an access token.
- One set is the
client_idandclient_secret, which tells us the application you’ve built to access Volt’s API. - You should create applications under your PSP account.
- The other set of credentials is the
usernameandpasswordwhich tells us the merchant whose data you’ll be accessing during this API session. - You’ll need to create a username and password for each individual merchant who will use Volt’s services.
Where to find the username and password
The merchant’s username and password are available in Fuzebox > Configuration > Customers
To use the Volt API as a Technical Service Provider (TSP) you’ll need two sets of credentials to first pass to our authentication endpoint and obtain an access token.
- One set is the
client_idandclient_secret, which tells us the application you’ve built to access Volt’s API. - You should create applications under your TSP account.
- The other set of credentials is the
usernameandpassword, which tells us the merchant whose data you’ll be accessing during this API session. - Each individual merchant using your integration to access Volt’s services will be able to generate their own username and password.
Where to find the username and password
Your merchant will find their username and password in Fuzebox > Configuration > Customers
| How to generate customer credentials | Find in Fuzebox |
Where to find your client_id and client_secret
Your client_id and client_secret are available for each application you have created in Fuzebox > Configuration > Applications
| How to create application credentials | Find in Fuzebox |
Generate an access token
See the request and response as described in our API docs for authentication.
After a successful authentication you’ll receive an access_token, a refresh_token and expires_in indicating the validity of the access_token in seconds. The access_token allows you to communicate against with the Volt API.
Using your access token
An access_token is valid for the number of seconds indicated by the expires_in value in the response. You also received a refresh_token in the authentication response, which will be valid for 24 hours, and which allows you to obtain a new access_token without needing to re-authenticate.
To access the other endpoints in our API, you need to send the access_token in an HTTP header called “Authorization” in the format “Bearer {access_token}”. Note that Authorization must be spelled with a “z” and there’s a single space between Bearer and your access token.
Authorization: Bearer eyJ...In0