Find Mandate (External IDs)

Qué hace

Consulta el detalle de un mandato ONEPAY.

Cuándo usarlo

Úsalo para reconciliación, soporte, confirmación de creación o consulta de estado.

Endpoint

GET /mandate/onepay/confirm/id/{mandateExternalId}

Autenticación

Requiere x-api-key y, salvo login/JWE, Authorization: Bearer <JWT> obtenido desde POST /login.

Headers requeridos

• country, commerce y channel identifican el contexto comercial autorizado.
• requestDateTime contiene la fecha y hora de la solicitud.
• correlationId identifica la solicitud y se recomienda un UUID para trazabilidad.
• processId y salesExecutiveId son obligatorios en este contrato.
  Consulta las restricciones y los valores asignados a tu integración en los parámetros de la operación.

Identificadores soportados

Busca por mandateExternalId externo del comercio.

Body / Parámetros

No requiere body.

Reglas de negocio

• La búsqueda siempre queda acotada al comercio autenticado.
• No devuelve mandatos de otros comercios aunque el id exista.

Respuesta exitosa

HTTP 200 con message=ONE_PAY_CONFIRM_OK. El campo exterior payload contiene el resultado del flujo con su propio estado, mensaje y payload. Lee payload.payload.businessPartner, customer, product e installments para obtener el resultado de confirmación. Revisa product.state y los estados de las cuotas para conocer el resultado del pago.

Errores comunes

• 400: validación de headers, path, query o body.
• 403: credenciales, API key o JWT inválidos/no autorizados.
• 404: recurso no encontrado cuando aplica.

Notas de integración

• Mantén correlationId único por intento para trazabilidad.
• No reutilices ejemplos con datos reales en producción; reemplaza placeholders por valores del comercio.

Ejemplo recomendado

Usa el ejemplo incluido en el body del request como plantilla inicial y reemplaza los placeholders {{...}} o <...>.