Authentication

Getting started with the Orbital API is simple. First, you will need an API key, which acts as your gateway to accessing our range of payment integration tools. Every API call is secured by an API Key and authenticated via the header
x-api-key: {{your api key}}.

Here's a simple guide on how to get your API key:

1. Log in: at https://www.getorbital.com/

2. API Key Generation: Once logged in, navigate to the eCommerce (bottom left), click configurations and API settings section of your account dashboard. Here, you'll find an option to generate a new API key.

3. Generate Key: Click on the "Generate API Key" button to create your unique API key. You may also have the option to specify any additional permissions or restrictions for your key, depending on your security preferences.

   • You can generate up to 5 API keys.
   • Payins & Deposits - API keys for processing deposits can be created without needing a second approval, and do not have IP whitelisting restrictions on them.
   • Payouts & Withdrawals - API keys capable of processing payouts & withdrawals will need a second person for approval, and require IP whitelisting (see 6. below).

4. Copy Key: Once generated, copy your API key to your clipboard. Treat this key like a password and store it securely, as it grants access to your account's API functionality.

5. Include in Request Headers: In your API requests, include your API key in the HTTP headers using the following format:

   Header

   x-api-key: {{your api key}}

   Simply replace {{your api key}} with the actual API key you obtained earlier.

6. "Allow List" for IP Address Whitelisting: You will need to add your server IP address to this section if your account supports Payouts/Withdrawals (Not required for Payin/Deposit Only API Keys).

By following these steps, you'll be able to authenticate your requests start of the Orbital API.

If you have any questions regarding integration, please speak to your Orbital Implementation Manager.
If you are a new client interested in our services, please complete the contact form on our website: https://www.getorbital.com/contact