Developer Portal

Create an account

To try out our APIs, you need to first create an account with our simple registration process. Setting up an account is free of charge.

1. Create account to get started.
2. Enter the required details and click  Create account.

You Might Already Have Credentials

If you already have Bottomline credentials for the API you want to try, skip to step 6 (Try out our APIs).

Create an application

To be able to consume an API, you must first create an application and associate it with the API.

1.  Sign in to your account.
2.  In the navigation bar, click My applications.
3.  Click Create application.





4. Enter a name and a description for the application. Click Create application.
   

You Might Already Have Credentials

If you already have Bottomline credentials for the API you want to try, skip to step 6 (Try out our APIs).

Request access to an API

Once you have created an application, you can request access to an API product featured on the developer portal.

1.  Sign in to your account.
2.  Navigate to the API you wish to access.
3.  Click Access this product.





4.  On the popup, select your existing application from the dropdown.
5.  Click Request access.
6.  An administrator will review your request for access. To view the status of your request, go to My applications.

You Might Already Have Credentials

If you already have Bottomline credentials for the API you want to try, skip to step 6 (Try out our APIs).

Get your API credentials

Before using an API, you will need to retrieve your API key and secret from My applications.

1.   Sign in to your account.
2.   Click My applications at the top of any page of the developer portal.
3.   Click the More information button on the application you wish to access.
4.   On the Approved access tab, click the View secret keys button alongside the API requested.
5.   On the popup, you can also view related information such as the application’s Client ID, Client Secret and any    relevant Scopes. The API key is used to access products that are associated with your application. The secret    key is used to encrypt and decrypt messages.

Try out our APIs

To try out our APIs you must generate an Authentication Token using the API credentials from your application. You can then use the Authentication Token to make calls with the API. Not all the APIs can be tried out. Only API specifications which show a Send API Request button to the right provide this capability.

1.  Navigate to the API you wish to try.
2.  Click on the Technical overview tab.
3.  Follow the explanations in the section which describes how to generate an Authentication Token using the API credentials for your application.
4.  Click on the API specification tab.
5.  In the navigation bar, click the endpoint and method you want to try.
6.   If the API enables this capability, you will see a button to Send API Request.







7.  Enter your generated Authentication Token in the Token field and provide a suitable value for any required parameters (denoted with an *) in the fields provided.
8.  Click Send API Request.