Skip to main content

​
Comenzar

Documentación para integrar Zopay Connect (API REST en /connect/v1) y el paquete npm @zopay/js (widget de pagos en el navegador).

​
Cómo encajan API y SDK

  • Connect API vive en tu servidor. Crea payment intents, mueve fondos, lee balances. Autentica con una clave sk_live_… o sk_test_….
  • @zopay/js vive en el navegador. Monta el widget de pago con el envelope PaymentIntent que tu servidor creó. No usa claves y nunca habla con ZoPay directo — sus lecturas de estado pasan por tu backend.
La misma clave Connect cubre toda la superficie de la API.

​
Crear cuenta y clave

Cuenta y clave API

Cómo generar tu clave y autenticar peticiones.

​
Empezar a construir

Entornos: sandbox vs live

Ambos modos sobre redes reales con dinero real. El prefijo de la clave decide aislamiento y helpers.

Verificar autenticación

GET /connect/v1/health (no exige cuenta aprobada).

Primer payout

POST /payouts/quote + POST /payouts.

Checkout web con SDK

Servidor crea intent → cliente monta widget.

​
Casos de uso

Pagos en sitio web (SDK)

Botón, payment intents y widget QR.

Enviar fondos (payouts)

Cotización y ejecución hacia una dirección on-chain.

Direcciones de depósito

Crear y listar direcciones para recibir fondos.

Balances y capacidades

Consultar saldos y qué redes/monedas tiene habilitadas tu cuenta.

​
Referencia y estado del API

Disponibilidad de endpoints

Qué rutas están operativas hoy y cuáles responden not_yet_available.

Errores de la API

Formato del envelope { error: { ... } } y doc_url.

Connect API

Referencia completa generada desde OpenAPI.

SDK

mountPaymentWidget, createPoller, normalizeIntent.