Recharge Management API Introduction

Please always check our CHANGELOG to find any API changes.

Overview

The Recharge Management API offers a comprehensive set of capabilities to efficiently manage recharges within our services. This documentation provides essential information to help you maximize the potential of our API and streamline recharge management for a wide range of operators and services.

Base url

Our production base url is: https://api.vzlaonlineservices.com/v3

Sandbox url

Sandbox environment is currently under maintenance. Please ask your sales manager for more information about this.

Current API Capabilities

Supported Operators

Movistar Mobile Prepaid

Movistar Mobile Postpaid

Movistar Landline Prepaid

Movilnet Mobile Prepaid

Digitel Mobile Prepaid

Digitel Mobile Postpaid

SimpleTV

Authentication

Access to our API mandates the use of an API key and secret. To obtain these credentials, please reach out to your designated sales representative. Every request made to the API must include the 'x-api-key' and 'x-api-secret' headers to ensure the necessary authentication and security for all interactions with our system. This authentication requirement applies to all API endpoints.

Sending Data to the API

To transmit data to the API, employ the request body in JSON format (MIME type: application/json). This approach guarantees a streamlined and consistent data exchange process. The API exclusively accepts JSON format in the request body, making it the preferred and mandatory method for data transmission.

Error Handling

Any HTTP status code other than a successful response (e.g., 20X) signifies an error in the API response. In the event of an error, the response body adheres to the following base format:

{
    "success": false,
    "message": "Error description.",
    "requestId": string,
    "data"?: [] || {}
}

Our aim is to provide clear error messages that pinpoint the issue's root cause. You can typically find the most relevant error information in the "message" property of the error response. Every response will include a "requestId" that we could use to trace support requests; please include this id in your support tickets to facilitate the request trace. Additionally, the "data" attribute may be included to offer further context or details. Please note that the "data" attribute is optional and may not be present in every error response.

INTRODUCTION

Recharge Management API Introduction#

Overview#

Base url#

Sandbox url#

Current API Capabilities#

Supported Operators#

Authentication#

Sending Data to the API#

Error Handling#