Developers · Sandbox QA

Integra la API de Coloca, paso a paso.

Todo empieza en QA, nuestro sandbox: un entorno de pruebas separado de producción, donde nada mueve dinero real. Creas tu cuenta, verificas tu organización, pides tus API keys y construyes tu integración con la documentación como guía.

Documentación

La documentación de la API es tu guía.

Ahí está todo para integrar: cómo autenticarte, cada endpoint con ejemplos de request y response, y los códigos de error. Puedes probar los endpoints desde la misma página. Tenla abierta en cada paso.

  • Inicio rápido
  • Autenticación con x-api-key
  • Verificación de la cuenta
  • Cobros (payins) y envíos (payouts)
  • Billeteras, cotizaciones y swaps
  • Tarjetas e identidades
  • Webhooks
Cómo empezar

Cinco pasos, del registro a la revisión técnica.

Hazlos en orden: cada paso desbloquea el siguiente. Todo ocurre en QA, así que puedes probar sin miedo.

01Panel QA

Crea tu cuenta en el sandbox

Entra a app.qa.colocapayments.com y elige Registrarse. Con el registro se crean tu organización y tu usuario, que queda como administrador.

  • Completa el formulario con tus datos y los de tu empresa.
  • Te llega un código de 6 dígitos al correo: ingrésalo para confirmar tu email.
  • Tu equipo no necesita registrarse: después los invitas desde Ajustes → Acceso y permisos.

QA es independiente de producción: aunque ya tengas cuenta en producción, crea una nueva en QA. Recomendado: activa la autenticación de dos factores (2FA) en Ajustes → Seguridad.

02Verificación

Verifica tu organización (KYC/KYB)

Tu organización se verifica una sola vez, desde el panel. En QA la verificación es simplificada: no tienes que cargar documentos.

  • En el panel toca Verificar ahora y elige cómo verificarte: como persona (KYC) o como empresa (KYB).
  • Completa el flujo guiado hasta que tu organización quede en VERIFIED.
  • Mientras tanto ya puedes activar billeteras, recibir dinero y convertir; para enviar dinero (payouts) necesitas estar VERIFIED.
03Correo

Pide que habilitemos tus API keys

La creación de API keys viene desactivada, también en QA. Escríbenos a hello@colocapayments.com y la activamos para tu organización: en sandbox se habilita directo, sin revisión previa.

  • Escríbenos desde el mismo email con el que te registraste en QA.
  • Cuéntanos el nombre de tu organización y qué vas a integrar: cobros, envíos, tarjetas…
  • Te respondemos por el mismo correo cuando quede activa. El botón de abajo te deja el correo listo.
04API

Crea tu API key e integra

Con la creación activada, genera tu clave en el panel y construye tu integración contra el sandbox, siguiendo la documentación.

  • En Ajustes → Acceso y permisos → API Keys, crea una clave solo con los permisos (scopes) que necesitas.
  • Cópiala apenas la crees: se muestra una sola vez. Guárdala en un gestor de secretos, nunca en el frontend ni en un repositorio.
  • Envíala en el header x-api-key de cada solicitud (no como Bearer). Base URL de QA: https://api.qa.colocapayments.com/api/v1.
  • Empieza por GET /public/account/verification: confirma tu estado y qué operaciones tienes habilitadas.
Tu primer llamado
curl https://api.qa.colocapayments.com/api/v1/public/account/verification \
  -H "x-api-key: $COLOCA_API_KEY"
Buenas prácticas desde el primer día
  • Envía Idempotency-Key en toda operación que mueve dinero, para no duplicarla si reintentas.
  • Maneja los errores por el campo code, no por el texto del mensaje (por ejemplo, organization_verification_required).
  • Configura tu webhook y valida el secreto x-secret en cada notificación.
05Meet

Agenda tu revisión técnica

Cuando tu flujo funcione de punta a punta en QA, agenda una reunión por Meet con nuestro equipo técnico y muéstranos tu integración funcionando.

Antes de agendar, confirma que:

  • Tu organización en QA está verificada y tu flujo principal funciona de punta a punta.
  • Usas Idempotency-Key en las operaciones que mueven dinero y manejas bien los reintentos.
  • Manejas los errores por code: validación, saldo insuficiente, verificación requerida, límites de monto.
  • Tu webhook está configurado, pasa la prueba de conexión y valida x-secret.
  • Tus API keys están guardadas de forma segura y tienen solo los permisos necesarios.
  • Consultas el estado de las operaciones (endpoints de consulta o webhooks), sin depender solo de la respuesta inicial.

En la reunión nos muestras tus casos de uso funcionando, el manejo de errores, la idempotencia, los webhooks y cómo proteges tus API keys. Si se aprueba, quedas listo para producción; si hay observaciones, te las compartimos y agendamos otra revisión.

Después de la revisión

El paso a producción.

Con estas dos aprobaciones activamos la creación de API keys en tu cuenta de producción, donde tu organización también debe estar registrada y verificada:

  1. 1Tu revisión técnica, aprobada.
  2. 2La propuesta comercial, aprobada: fija las condiciones y los costos de operación.

Luego creas tus API keys productivas y configuras la base URL y el webhook de producción. Recomendado: restringe las IPs permitidas, define vencimientos y rota tus claves periódicamente.

EntornoPanelAPI (base URL)Para qué
Sandbox (QA)app.qa.colocapayments.comapi.qa.colocapayments.com/api/v1Pruebas, sin dinero real
Producciónapp.us.colocapayments.comapi.us.colocapayments.com/api/v1Operación real

Las claves y la configuración de QA no funcionan en producción, ni al revés: usa claves distintas en cada entorno.

Empieza hoy en el sandbox.

Crea tu cuenta en QA y ten la documentación a mano desde tu primer llamado.

¿Dudas en algún paso? Escríbenos a hello@colocapayments.com