Getting Started

error_outline

note

This product is under construction

We don't have a release date for the Converge Billing and Invoicing API at this time. Please contact your Relationship Manager for more information.

Before You Start

Recommended Knowledge

If you are not already familiar with HTTP protocols protocols and REST APIs, take some time to familiarize yourself with them before you start working with Converge Billing and Invoicing.

Set Up Your Development Environment

To get started, we recommend having the following software for working with the Billing and Invoicing API.

  • A REST API Client like Postman or client transfer protocol like cURL
  • Your website must run on a webserver with the following specifications:
    • SHA-2 Certification
    • TLS 1.2 Enabled

Get Started

Configure Converge

To get started with Converge Billing and Invoicing, you will need to have the following pieces of information:

  1. An account with Converge.
  2. A Converge Terminal set to the Service Segment.
  3. Access to the Converge Demo Environment.
  4. A Consumer Key and Secret

Get Converge Account from Admin

If you do not already have a Converge account ID for integrating with Converge API, contact your Converge account Administrator and ask them to create an account in the converge Demo environment with API User Permissions enabled. When your administrator finishes creating your account, you will receive an email with your Consumer Key and Secret.

Confirm Web UI Settings

The Billing and Invoicing API requires several terminal pieces of information from the Web UI and requires setting up Invoicing and Email templates. Refer to the Web UI Configuration for more information on these processes.

Endpoint URLS

The Billing and Invoicing API has a test endpoint and a production endpoint available for use.

  • Demo: https://cert-api.elavon.com/ecomm/billing/v2

This is the testing URL for the Bulling and Invoicing API. Use this endpoint for testing your Billing and Invoicing API integration.

  • Production: https://api.elavon.com/ecomm/billing/v2

This is the production URL for the Billing and Invoicing API. Do not use this URL until your integration is ready to enter production.

Next Steps

After you get access to the Converge Demo Environment, you can begin developing with the API.

For more information on authenticating with the Elavon API Gateway, refer to Authentication.

For more information on the different endpoints and methods, refer to the Billing and Invoicing API Reference.