# Documentación de Efipay

<!-- Fuente: https://docs.efipay.co/overview -->

---

- [Documentación de Efipay](#overview)
  - [Qué puedes hacer con esta API](#que-puedes-hacer)
  - [Empieza aquí](#empieza)
  - [Cómo está organizada esta documentación](#organizacion)
  - [Mejores prácticas](#mejores-practicas)
  - [Lo esencial en un minuto](#esencial)
  - [Soporte](#soporte)

## Qué puedes hacer con esta API [#que-puedes-hacer]

Cobrar. Con tarjeta, PSE, efectivo, Bre-B o Nequi; una vez o de forma recurrente;
mandando a tu cliente a nuestro checkout o capturando el pago en el tuyo.

| Quiero | Empieza en |
| - | - |
| Cobrar un pago único | [Generar un pago](/generate-transaction) |
| Cobrar desde mi propio checkout | [Checkout por API](/checkout-transaction) |
| Cobrar cada mes | [Suscripciones](/subscription) |
| Retener un cupo y cobrar después el valor real | [Reserva de cupo](/mit-pre-authorization) |
| Guardar la tarjeta de mi cliente | [Tokenizado](/tokenized) |
| Recaudar facturas desde mi ERP | [Conexión a ERP](/documentation-erp) |
| Saber en qué quedó un pago | [Estado de transacción](/status-transaction) · [Webhooks](/webhooks) |
| Devolver dinero | [Refund / Reversión](/refund-transaction) |
| Ver lo que se transfirió a mi banco | [Transferencias](/transfers) |
| Integrar sin escribir código | [Shopify](/shopify-integration) · [WooCommerce](/woocommerce-integration) · [PrestaShop](/prestashop-integration) · [Magento](/magento-integration) |

## Empieza aquí [#empieza]

Si es tu primera vez, sigue este orden:

1. **[Autenticación y ambientes](/authentication)** — cómo se
   autentica cada llamada y en qué se diferencian prueba y producción.
2. **[Tu primer pago](/first-payment)** — de cero a un pago
   aprobado, con `curl`. Diez minutos.
3. **[Ambiente de pruebas](/sandbox)** — las tarjetas de prueba y
   la lista de verificación antes de pasar a producción.
4. **[Webhooks](/webhooks)** — cómo te avisamos del resultado y
   cómo verificar la firma. **No te lo saltes**: es lo que separa una integración que
   funciona de una que parece funcionar.

## Cómo está organizada esta documentación [#organizacion]

| Sección | Para qué |
| - | - |
| **Primeros pasos** | Lo que necesitas antes de escribir código |
| **Cobrar** | Los endpoints que crean y procesan un pago |
| **Consultas y webhooks** | Cómo sabes en qué quedó |
| **Suscripciones** | Cobros recurrentes, planes y cupones |
| **Reserva de cupo** | Retener ahora, cobrar después |
| **Cuenta virtual** | Lo que se transfiere a tu banco |
| **Referencia** | Catálogos, códigos de error, convenciones y glosario |
| **Integraciones sin código** | Plugins para plataformas de e-commerce |

Cada página de la referencia sigue la misma forma: para qué sirve el endpoint, la tabla
de campos con sus reglas, un ejemplo ejecutable y la respuesta —de éxito **y** de error.

## Mejores prácticas [#mejores-practicas]

Cada cobro generado con
[generate-payment](/generate-transaction) admite **un solo intento
de transacción**, sea por URL de checkout (`redirect`) o por
[API](/checkout-transaction). Si el pago es rechazado, genera un
`payment_id` nuevo; no reutilices el anterior.

## Lo esencial en un minuto [#esencial]

```
URL base       https://sag.efipay.co/api/v1
Autenticación  Authorization: Bearer TU_TOKEN
Formato        JSON, con Accept: application/json
Ambientes      El tipo de token decide: prueba o producción. Misma URL
Montos         En la unidad de la moneda, no en centavos: 120000 = $120.000
Fechas         Y-m-d al enviar; ISO 8601 al recibir (UTC, o con offset -05:00 en los campos nuevos)
Errores        Decide con error.code, presente en todo 4xx
Versión        v1. Dentro de una versión solo agregamos campos, nunca los quitamos
```

Detalle en [Convenciones](/conventions).

:::note
Genera tus tokens, encuentra el id de tu sucursal y tu token de webhooks en
[Documentación → API key](https://sag.efipay.co/documentacion/api-key).
:::

## Soporte [#soporte]

Antes de escribirnos, dos páginas resuelven la mayoría de las dudas:

- **[Códigos de error](/error-codes)** — qué significa cada código
  y qué hacer con él.
- **[Glosario](/glossary)** — si un término no te suena.

Si sigues bloqueado: [soporte@efipay.co](mailto:soporte@efipay.co). Cuéntanos qué
endpoint llamaste, qué enviaste y qué recibiste; si tienes el `transaction_id` o el
`payment_id`, inclúyelo.

---

Versión de la API: **1.0** · Efipay