Work With API Reference Documentation
Each Gotransverse APIs window includes an overview of the service, a list of all endpoints, the methods available for each endpoint with payload examples, as well as a way to send a request in a live mode.
Gotransverse Billing API Reference Window
The following table describes each area of the window and its purpose or function (numbers correspond to the image above):
Feature | Description |
---|---|
1 | The Gotransverse logo is a link back to the Gotransverse APIs topic on the API Help site. |
2 |
The API drop-down list includes all the services that are supported by Gotransverse billing platform. Select an API from the list to switch views.
Gotransverse API Drop-Down List |
3 |
Try it feature allows you to send a live request. |
4 |
Export allows you to export the API Reference Documentation (in JSON format) using either of the following options:
|
Complete the following steps before sending a live API request:
-
Click the Try it button to open the Would you like to try? window.
-
In the Try it URL field, enter the URL of your environment.
-
Click Save to apply your changes.
Try it
After saving your URL in the Would you like to try? window, complete the following steps to send a live API request:
-
Select an endpoint.
-
Enter the X-API-Key.
-
Enter parameters.
-
Click Send API Request.
Send API Request
Topic Updated: 1/2025.