Actualizar onboarding
Actualiza los datos o la documentación de un onboarding existente de un destinatario
Requisitos previos
Este endpoint requiere un onboarding existente creado mediante Create OnboardingCuentas con onboarding previo
Para volver a registrar un onboardingPREVIOUSLY_ONBOARDED existente, por ejemplo después de que terminó en ERROR porque un id de cuenta era incorrecto, llama a PATCH /v1/recipients/{recipient_id}/onboardings/{onboarding_id} con el objeto provider: provider.id, provider.connection_id y los ids de cuenta.
provider.recipient_id, provider.recipient_additional_id, provider.balance_account_id, provider.legal_entity y provider.recipient_type. Cuáles de ellos necesita un proveedor lo define su integración. Se reenvían exactamente como se envían.
- La integración admite adoptar cuentas existentes: Yuno repite el registro en el proveedor y aplica su respuesta. El onboarding pasa a
SUCCEEDED(webhookonboarding.succeeded) o aERRORcon el mensaje del proveedor enresponse_message(webhookonboarding.error). Un onboarding enERRORpasa aSUCCEEDEDuna vez que el proveedor acepta los ids corregidos. - Cualquier otro proveedor: los ids se almacenan y no se hace ninguna llamada al proveedor. No se validan en el proveedor.
Actualizar una cuenta bancaria
Para los onboardings de Zoop y Pagar.me con un ID de destinatario del proveedor, una actualización explícita dewithdrawal_methods.bank espera el resultado del proveedor. Actualiza solo el onboarding seleccionado; el valor predeterminado del destinatario y los demás onboardings permanecen sin cambios.
Solo se guarda para el onboarding una cuenta confirmada. Los resultados de la actualización bancaria no cambian su estado de ciclo de vida. Envía una cuenta completa cuando el onboarding no muestre ninguna cuenta bancaria. Consulta errores bancarios y reintentos para ver resultados parciales, respuestas 400 y la guía de conciliación de 409.
Para estos onboardings compatibles vinculados al proveedor, los campos que no son bancarios, distintos de documentation, se guardan en Yuno sin una actualización separada del perfil en el proveedor. Enviar una descripción o metadata no reenvía la cuenta bancaria guardada. En una solicitud mixta, el banco se procesa primero; los demás campos se guardan solo después de que tenga éxito. Los destinatarios incorporados previamente conservan la notificación de estado existente para las actualizaciones no bancarias sin documentation.
Por ejemplo, cambiar solo la descripción de una tienda deja sin cambios su cuenta de pago confirmada y el estado del onboarding. Para cambiar la cuenta de pago, incluye withdrawal_methods.bank de forma explícita.
Actualizar la documentación
Para los onboardings de Zoop con un ID de destinatario del proveedor, una solicitud condocumentation envía a Zoop los documentos de esa solicitud y espera el resultado. Esto incluye a los destinatarios incorporados previamente. Solo se envían las categorías de documentos de la solicitud, y la cuenta bancaria no se reenvía.
- Si Zoop acepta los documentos, el onboarding toma el estado y los requisitos que informa Zoop, y se envía el webhook de onboarding habitual.
- Si Zoop rechaza los documentos, o no se puede confirmar el envío o el estado resultante, la respuesta es
400con el códigoPROVIDER_OPERATION_FAILED. Los documentos se guardan en Yuno, y el onboarding conserva su estado y requisitos anteriores. Reenvía solodocumentation. - En una solicitud que también actualiza la cuenta bancaria, la actualización bancaria se procesa primero. Si luego fallan los documentos, el
400también informa el resultado bancario. Un cambio bancario informado comoAPPLIEDpermanece aplicado, por lo que debes reenviar solodocumentation.
CANCELLED, BLOCKED, INACTIVE o TRANSFERRED rechazan las actualizaciones con 400 INVALID_STATE, excepto los destinatarios incorporados previamente: su actualización guarda documentation en Yuno sin enviarla al proveedor. Un onboarding TERMINATED siempre devuelve 400 INVALID_STATE.Autorizaciones
Parámetros de ruta
Cuerpo
Tipo de flujo de onboarding. PREVIOUSLY_ONBOARDED asocia una cuenta que ya existe en el proveedor, ONE_STEP_ONBOARDING crea la cuenta y hace el KYC en un solo paso, y TWO_STEP_ONBOARDING primero crea la cuenta y hace el KYC después.
Para volver a registrar un onboarding PREVIOUSLY_ONBOARDED, envía provider.id, provider.connection_id y los ids de la cuenta del proveedor. Cuando la integración del proveedor permite adoptar cuentas existentes, Yuno repite el registro y aplica la respuesta: el onboarding pasa a SUCCEEDED o a ERROR con el mensaje del proveedor en response_message. Con cualquier otro proveedor, los ids se guardan y no se llama al proveedor. Una actualización sin ids del proveedor solo vuelve a enviar la notificación del estado actual. Qué proveedores adoptan cuentas existentes es una configuración de Yuno por entorno; consulta a tu Key Account Manager.
PREVIOUSLY_ONBOARDED, ONE_STEP_ONBOARDING, TWO_STEP_ONBOARDING "PREVIOUSLY_ONBOARDED"
Proveedor del onboarding. En PREVIOUSLY_ONBOARDED, los ids de la cuenta del proveedor se reenvían a la integración del proveedor exactamente como se enviaron; qué ids necesita cada proveedor lo define su integración. Envía id y connection_id junto con los ids para volver a registrar la cuenta.
Respuesta
Actualizado