Placetopay Onboarding

Onboarding es la API que permite a tu aplicación registrar y actualizar comercios en Placetopay sin depender de una gestión manual en el Panel.

Envías el estado completo del comercio que quieres registrar —sus datos, sus sitios, sus integraciones y sus medios de pago—, Onboarding lo valida por completo y te devuelve un identificador de proceso con el que puedes seguir el resultado. El registro se realiza en segundo plano, de modo que tu aplicación no queda esperando.

Qué resuelve

Si tu negocio incorpora comercios de forma continua —una plataforma que habilita vendedores, un integrador que gestiona una cartera de clientes, un marketplace que da de alta tiendas—, registrarlos uno a uno desde el Panel deja de ser viable. Onboarding expone ese registro como un contrato estable que puedes automatizar.

Con una sola petición puedes crear un comercio completo: sus datos fiscales y de contacto, los idiomas y monedas con los que opera, sus sitios de venta con sus credenciales, las integraciones con proveedores y los medios de pago que acepta.

Cómo funciona, en resumen

1. Tu servidor envía el comercio a Onboarding con POST /api/merchants.
2. Onboarding valida todo el contenido y responde de inmediato con 202 y un processId.
3. El registro se ejecuta en segundo plano.
4. Tu aplicación consulta el proceso con GET /api/processes/{processId} hasta conocer el resultado.
5. Si registraste una URL de notificación, Onboarding te avisa con un webhook firmado en cuanto el proceso termina.

Puedes ver este ciclo en detalle, con diagramas, en Cómo funciona.

Requisitos previos

Para integrarte necesitas:

• Credenciales de acceso: un token de tipo Bearer emitido por Placetopay para tu aplicación. Se entrega una sola vez. Consulta Autenticación.
• Un servidor propio: los endpoints de Onboarding se consumen desde tu backend, nunca desde el navegador, porque la petición viaja con tus credenciales.
• Opcionalmente, un endpoint de notificación: una URL pública https en la que quieras recibir el resultado de cada proceso. Debes poder verificar una firma HMAC sobre el cuerpo recibido, como se explica en Notificación.

Cómo aprovechar esta documentación

La documentación está organizada en cuatro bloques que conviene leer en orden:

• Onboarding — entender el producto: cómo funciona el ciclo de vida y unos primeros pasos con el comercio más simple posible.
• Integración — cada pieza del ciclo, en el orden en que se necesita: autenticación, idempotencia, crear, consultar, notificación, actualizar y manejo de errores.
• Datos del comercio — el contrato de campos: los datos del comercio y las colecciones de integraciones y medios de pago.
• Sitios — los sitios del comercio y sus propias colecciones de integraciones y medios de pago.

Si quieres una integración funcionando cuanto antes, ve directo a Primeros pasos.