> For the complete documentation index, see [llms.txt](https://plexo.gitbook.io/rest-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://plexo.gitbook.io/rest-api/getting-started/readme.md).

# Quick Start Guide

Welcome to the Plexo REST API v1 documentation. This guide will help you integrate payment processing into your application.

## Overview

Plexo is a payment gateway that enables you to accept payments from customers using various payment methods including credit cards, debit cards, and PIX. Our REST API provides a secure and PCI-compliant way to process payments.

**Key Features:**

* Multiple payment processors and acquirers (Totalnet, OCA, Fiserv, Getnet, and more)
* 14+ supported payment methods
* 3D Secure (3DS) authentication via Cybersource
* Tokenization for secure recurring payments and one-time payments (temporal)
* Testing and production environments

## Authentication

All API requests require authentication using Basic Auth. You'll need your **clientId** and **api-key**.

```http
Authorization: Basic <base64_encoded_credentials>
```

Where `<base64_encoded_credentials>` is your `clientId:api-key` pair encoded in Base64.

**Example:**

```bash
# If clientId = "your_client_id" and api-key = "your_api_key"
# Encode: your_client_id:your_api_key
# Result: eW91cl9jbGllbnRfaWQ6eW91cl9hcGlfa2V5

curl -X POST https://api.testing.plexo.com.uy/v1/payments \
  -H "Authorization: Basic eW91cl9jbGllbnRfaWQ6eW91cl9hcGlfa2V5" \
  -H "Content-Type: application/json"
```

{% hint style="info" %}
To request your credentials, please contact Plexo support at **<soporte@plexo.com.uy>**
{% endhint %}

## Environments

Plexo provides separate testing and production environments. Each environment has independent credentials and databases.

{% hint style="warning" %}
**Important:** Always use the **testing environment** (`https://api.testing.plexo.com.uy`) for development and testing. Production environment processes real payments with real money. See the [API Environments Guide](/rest-api/getting-started/environments.md) for complete details.
{% endhint %}

{% tabs %}
{% tab title="Testing" %}
**API Base URL:**

```
https://api.testing.plexo.com.uy
```

**API Documentation:**

```
https://api.testing.plexo.com.uy/scalar/#coreapi
```

**Dashboard:**

```
https://dashboard.testing.plexo.com.uy
```

{% endtab %}

{% tab title="Production" %}
**API Base URL:**

```
https://api.plexo.com.uy
```

**Dashboard:**

```
https://dashboard.plexo.com
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
Always use the testing environment during development and integration. Each environment requires separate credentials.
{% endhint %}

## Test Cards

Use supported test cards and the `mock_v2` processor in the testing environment to simulate different payment scenarios.

For complete test card information including card numbers, CVV codes, and expected results, see [Reference > Test Cards](/rest-api/operations/testing/test-cards.md).

## Rate Limits

*Content to be added - current rate limit policies*

## API Version

This documentation covers **REST API v1**. This API will replace the legacy Webservices API in Q3 2026.

## Support

For technical support, integration assistance, or to request credentials:

* **Email:** <soporte@plexo.com.uy>
* **Dashboard:** Access your merchant dashboard for transaction monitoring, self-service API key generation, payment method configuration, and 3DS settings management. The dashboard provides a complete interface for managing your integration without contacting support.

## Next Steps

| Topic                                                                                                         | Description                                                                   |
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [Core Concepts](https://github.com/plexouy/gitbook-public-docs/tree/main/api-rest/en/core-concepts/README.md) | Learn about merchants, payment methods, 3DS, tokenization, and PCI compliance |
| [API Reference](/rest-api/api-reference/api-reference.md)                                                     | Detailed endpoint documentation for payments, merchants, and tokenization     |
| [Integration Guides](https://github.com/plexouy/gitbook-public-docs/tree/main/api-rest/en/guides/README.md)   | Step-by-step guides for common integration scenarios                          |
| [Reference](https://github.com/plexouy/gitbook-public-docs/tree/main/api-rest/en/reference/README.md)         | Payment methods, processors, test cards, and error codes                      |