Skip to main content
Connect es la API B2B de ZoPay para custodia crypto, depósitos, payouts y atribución por usuario. Todas las rutas viven bajo /connect/v1. Si es tu primera integración, empieza en Comenzar.

Arquitectura

REST + JSON. Cada petición autentica con un token Bearer (sk_live_… o sk_test_…). La misma clave cubre toda la superficie de Connect; el SDK del navegador no usa claves y sólo monta UI a partir de un payment_intent_id que tú creaste vía API.

URL base y modos

  • URL base: https://api.zopay.cash/connect/v1
  • Modo: lo decide el prefijo de tu clave — sk_test_...sandbox, sk_live_...live (visible en GET /health).
Ambos modos operan sobre redes reales con dinero real. La diferencia es aislamiento de datos y disponibilidad de helpers de prueba. Detalle en Entornos.

Recursos principales

RecursoEndpoints
Payment IntentsCrear, listar, consultar
AddressesCrear, listar, consultar direcciones de depósito
BalancesConsultar saldos por moneda
TransactionsListar y consultar transacciones
PayoutsCotizar y ejecutar payouts on-chain
CapabilitiesActivos, redes y límites disponibles
HealthVerificar autenticación
Sandbox helpersSimuladores /test/... para claves sk_test_…

Seguridad

  • Autenticación: token Bearer con tu clave Connect. Ver Autenticación.
  • Idempotencia: obligatoria en endpoints que crean recursos sensibles (POST /payment-intents, POST /addresses, POST /payouts/quote, POST /payouts). Ver Idempotencia.
  • Cuenta aprobada: los endpoints que mueven fondos exigen organización activa; GET /health es la excepción para validar la clave.

Estado de los endpoints

Algunas rutas (conversions, ramps, webhooks de gestión) están registradas en el spec pero responden not_yet_available (501). Lista en Disponibilidad de endpoints.
Para integrar pagos en una web con @zopay/js, ve a la pestaña SDK. El SDK monta el widget; el intent siempre se crea desde tu servidor con Connect API.