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

# Postman Collection

Optimiza tus pruebas e integración de API con la colección oficial de Postman de Localpayment. Esta completa colección ofrece solicitudes preconfiguradas para todos nuestros endpoints, lo que facilita explorar, probar y comprender nuestra API sin necesidad de escribir código.

## ¿Qué es Postman?

> [card] Plataforma de desarrollo de API
>
> Postman es una plataforma colaborativa para el desarrollo de API que simplifica la creación, las pruebas y la documentación de las API.

> [card] Pruebas sin código
>
> Prueba visualmente los endpoints de la API con solicitudes, entornos y flujos de trabajo automatizados predefinidos.

### Características principales de Postman

* **Colecciones**: Organiza las solicitudes de API en carpetas y compártelas con tu equipo.
* **Entornos**: Gestiona diferentes configuraciones (preproducción frente a producción) con variables.
* **Pruebas automatizadas**: Escribe y ejecuta pruebas para validar automáticamente las respuestas de la API.

> [!NOTE]
>
> **¿Eres nuevo en Postman?**
>
> [Descarga Postman](https://www.postman.com/downloads/) gratis y visita su [centro de aprendizaje](https://learning.postman.com/) para acceder a tutoriales completos.

***

## Comienza a usar la colección de Postman

### Descarga la colección

Obtén la última versión de nuestra colección Postman:

> [card] [Postman Collection](https://cdn.localpayment.com/public_docs/Postman/Postman%20Collection20241017.postman_collection)

### Importar a Postman

**Opción 1: Importación directa**

* Haz clic en el botón "Ejecutar en Postman" que se encuentra arriba.
* Postman se abrirá y te solicitará que importes la colección.

**Opción 2: Importación manual**

1. Abrir Postman
2. Haz clic en **Import** en la esquina superior izquierda.
3. Arrastra y suelta el archivo JSON descargado o selecciónalo desde tu ordenador.
4. Haz clic en **Import** para añadir la colección a tu espacio de trabajo.

### Configurar el entorno

Importa nuestra plantilla de entorno preconfigurada:

[Descargar plantilla de entorno](https://cdn.localpayment.com/public_docs/Postman/V3%20-%20Enviroment-%20STAGE.postman_environment)

Esto incluye todas las variables necesarias para realizar pruebas con las API de Localpayment.

***

## Configuración del entorno

El entorno de Localpayment contiene variables esenciales que deben configurarse para tus escenarios de prueba. Actualiza estos valores en tu entorno de Postman antes de realizar solicitudes.

### Variables ambientales

| Variable | Descripción | Valor de ejemplo | Requerido |
| - | - | - | - |
| `accountNumber` | Número de cuenta de Localpayment donde se realiza la operación | `3.203.200.000.001` | Sí |
| `baseUrl` | URL del entorno API (de prueba o de producción) | `https://api.stage.localpayment.com` | Sí |
| `userName` | Nombre de usuario para solicitudes de generación de tokens | `your_username` | Sí |
| `password` | Contraseña para solicitudes de generación de tokens | `your_password` | Sí |
| `accessToken` | Token de portador para autenticación de API (se rellena automáticamente a partir de las solicitudes de token). | `Bearer eyJhbGciOiJ...` | No |
| `refreshToken` | Token de actualización para obtener nuevos tokens de acceso. | `eyJhbGciOiJ...` | No |
| `country` | Código de país para operaciones (ISO 3166-1 alfa-3) | `MEX` | Sí |
| `externalId` | Identificador UUID4 generado automáticamente por Postman | `f47ac10b-58cc-4372-a567-0e02b2c3d479` | No |
| `internalId` | Identificador interno de la transacción (rellenado automáticamente por las respuestas de la API) | `0dcf3970-006a-46e8-b914-f3853abc3cf3` | No |
| `currency` | Código de moneda para operaciones (ISO 4217) | `MXN` | Sí |
| `conceptCode` | Código de concepto predefinido de la lista de conceptos de Localpayment | `0001` | Sí |

### Configura tu entorno

1. En Postman, haz clic en **Environments** en la barra lateral.
2. Selecciona el entorno **Localpayment Environment**.
3. Actualiza el **Current Value** de cada variable con tus credenciales reales.
4. Asegúrate de que el entorno esté seleccionado en el menú desplegable superior derecho.

***

## Estructura de la colección

Nuestra colección Postman está organizada por producto y funcionalidad para facilitar la navegación:

```
Localpayment API
├── Before a payment
│ ├── Authentication
│ ├── Validation Services
│ └── Resources
├── Payins
│ ├── Cards
│ ├── Virtual Accounts
│ └── Subscriptions
├── Payouts
└── Treasury & FX
  ├── FX Services
  ├── Reports
  └── Transactions
```

***

## Recursos adicionales

> [card] [Referencia de la API](https://docs.localpayment.com/es/reference)
>
> Documentación completa del endpoint con ejemplos de solicitud/respuesta y
> parámetros

> [card] [Webhooks](https://docs.localpayment.com/es/docs/webhooks.md)
>
> Configura y verifica los endpoints de webhook para recibir notificaciones de eventos en tiempo real.

> [card] [Centro de Aprendizaje de Postman](https://learning.postman.com/)
>
> Documentación oficial de Postman, tutoriales y mejores prácticas para pruebas de API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.