Developer Tools

Using Swagger

Swagger is a tool that can be used to ascertain API request methods and responses that pertain to Elavon’s API. Swagger shows the structure of APIs, along with example data.

To use Swagger, go to the API Reference that pertains to the APIs you want to view and test, and download the file:

Navigating Swagger

Once you are logged into Swagger:

  • Select and hold CTRL+F or scroll to search for API operations.

  • Click on an API operation to open it and see its parameters. Click on it again to close it.

  • Toggle between two views–Model and Example Value that are in the middle of the screen in the body section.

  • Example Value appears first by default.

  • Model provides descriptions of each variable. Expand the data model by clicking the caret symbols.

  • The active view name is indicated in bold.

  • Click Example Value to return to the sample code view.

Note: Swagger and Postman sometimes render the API reference example data so that it is not visible. When in doubt, refer to the sample data.

1. Install and/or Setup a REST-Client

The first step is to install and setup a REST-Client such as Postman or Swagger Inspector. A REST-Client helps manage and test authentication keys, requests, and responses.

2. Setup Authentication on your REST-Client

You need to use your Elavon API credentials for every API call. On your REST-Client, you need to enter authentication keys you received to access the API.

3.Base URL

Refer to the prerequisites page to configure Swagger with the appropriate certification or production endpoint.

4. Test the API

Test and confirm that the API is up and running.

Using Postman

This online guide is a good way to get a high-level understanding of how our APIs work. However, when you’re ready to start working with live data and are testing our APIs, we recommend downloading Postman.

Postman was designed for API testing. HTTP requests are tested, by means of a graphical user interface. Different types of responses are obtained, which are then subsequently validated.

Please reach out to your Elavon Relationship Manager. See Contact Us to receive API credentials and import our Postman Collections.