Documentación de Efipay

Documentación de Efipay

Qué puedes hacer con esta API

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
Cobrar desde mi propio checkout	Checkout por API
Cobrar cada mes	Suscripciones
Retener un cupo y cobrar después el valor real	Reserva de cupo
Guardar la tarjeta de mi cliente	Tokenizado
Recaudar facturas desde mi ERP	Conexión a ERP
Saber en qué quedó un pago	Estado de transacción · Webhooks
Devolver dinero	Refund / Reversión
Ver lo que se transfirió a mi banco	Transferencias
Integrar sin escribir código	Shopify · WooCommerce · PrestaShop · Magento

Empieza aquí

Si es tu primera vez, sigue este orden:

Autenticación y ambientes — cómo se autentica cada llamada y en qué se diferencian prueba y producción.
Tu primer pago — de cero a un pago aprobado, con curl. Diez minutos.
Ambiente de pruebas — las tarjetas de prueba y la lista de verificación antes de pasar a producción.
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

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

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

Lo esencial en un minuto

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.

Soporte

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

Códigos de error — qué significa cada código y qué hacer con él.
Glosario — si un término no te suena.

Si sigues bloqueado: 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