Skip to main content

Register your application

Once you've got a merchant account, you'll need to register an application that you'll use to access the Volt API.

An application could be a website, mobile app, or any other application you'll be using to consume API resources.

This can be done by going to the Applications section, which you'll find under Configuration in Fuzebox

sidebar applications

Creating the application#

Add your application name - for example "My website checkout"

create_application image

Return URLs#

Once your customer has completed the payment experience it will result in either a success, pending or failure state and we'll redirect them to the appropriate URL as configured.

  • On payment success - where your customer will be redirected to once a payment has been confirmed as sent.
  • On payment failure - where your customer will be redirected if a payment fails or if the customer cancels at any point in the process.
  • On payment pending - where your customer will be redirected to if a payment has been delayed for any reason. A pending status can change to a success or failure at any time - we'll let you know via a notification.

You can use the same URL for all three - just enter the same URL into each box. We'll send the same details including a status code, to whichever URL we redirect your user to.

Custom parameters#

If you would like us to send custom parameters back to your return URL when the customer is returned to you, you can now pass them in your payment request. See the documentation requesting a new payment for more details.

Application credentials#

In Fuzebox, you'll now be able to see a Client ID and a Client Secret. These are your appplication credentials, which you'll need to use, along with your merchant credentials, to access the Volt API.

The application credentials tell us how you'll be accessing the API, whereas the API user credentials tell us who you are.

Keep your secret... secret

Make a note of the secret and keep it securely as you'll only be able to retrieve it once. You can, however, generate a new secret at any time in Fuzebox in case yours becomes compromised.

Why not Application ID and Secret?#

The application you create is referred to as a client by oAuth2.0 when talking about authentication. The terms client and application mean the same thing but (except for API authentication) we'll always use Applications.