> ## Documentation Index
> Fetch the complete documentation index at: https://docs.v2.topup.com.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Comprehensive Guide to TumiPay API Integration.

# API Reference

This section contains endpoint-level documentation. For conceptual overviews and country-specific configuration, see the [Overview](/docs/introduction) page and country configuration pages: [Colombia](/docs/co/introduction), [Peru](/docs/pe/introduction), and [Mexico](/docs/mx/introduction).

## Authentication

All API requests require authentication. Tumipay uses two methods of authentication:

Basic Authentication requires a username and a password for secure access:

```
Authorization: Basic base64(username:password)
```

These credentials are provided when you register as a Tumipay merchant.

In addition to Basic Authentication, most endpoints require a token in the request headers:

```
Token-Top: your_access_token
```

This token is unique to your merchant account and should be kept secure.

## API Overview

Tumipay offers three main API categories to handle different aspects of payment processing:

<CardGroup cols={3}>
  <Card title="Merchant API" icon="user-tie" href="/api-reference/merchant-api">
    Retrieve balance and search transaction history
  </Card>

  <Card title="PayIn API" icon="credit-card" href="/api-reference/payin">
    Process incoming payments with multiple methods
  </Card>

  <Card title="PayOut API" icon="money-bill-transfer" href="/api-reference/payout">
    Execute disbursements and bank transfers
  </Card>
</CardGroup>

## Getting Started

To obtain the necessary credentials for accessing and using our APIs, please send an email to [**it@tumipay.co**](mailto:it@tumipay.co). This process is required for the secure generation and assignment of your personal API credentials.

## Environments

### Staging Environment

During development, use our Staging (Sandbox) environment for testing. This environment simulates real operations but does **not process actual monetary transactions.**

```
Base URL: https://api-empresas.staging.topup.com.co/production/api
```

In the Sandbox environment:

* To perform payouts, you must first create a successful payin to add funds to your test balance.
* Test transactions can be simulated using specific test parameters provided in this documentation.
* No real money is processed or transferred.

Once your integration is complete and thoroughly tested:

1. Send us an email with your test results to [**it@tumipay.co**](mailto:it@tumipay.co) for review.
2. After approval, request your production credentials.
3. Update your API base URL to the production endpoint.