Find (Internal ID)

Find Mandate (Internal 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 https://devapi.forpayservices.cl/white/label/mandate/onepay/confirm/internalId/{{mandateId}}

Autenticación

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

Headers requeridos

  • country: CL para integraciones en Chile.
  • commerce: RUT o identificador del comercio entregado por Forpay. Debe coincidir con las credenciales/JWT.
  • channel: Canal de integración acordado con Forpay.
  • requestDateTime: Fecha y hora de la solicitud en formato ISO 8601. En Postman se genera con currentDate.
  • correlationId: UUID único de trazabilidad. En Postman se genera automáticamente antes de cada request.
  • processId: Proceso funcional declarado para auditoría, por ejemplo HYBRID.
  • salesExecutiveId: Identificador del ejecutivo o integración comercial, cuando aplique.
  • x-api-key: API key del ambiente. En documentacion se deja como placeholder.

Identificadores soportados

Busca por mandateId interno Forpay.

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

Devuelve MANDATE_DETAIL_OK con datos del mandato, cliente, estado, medio de pago y configuración disponible.

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 <...>.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identificador interno Forpay del mandato ONEPAY.

Headers
string
enum
required

Identificador de país donde proviene la solicitud

Allowed:
string
required

Identificador único del comercio asociado definido por forpay

string
required

Tipo de plataforma usada por el comercio para integrarse con Forpay

date-time
required
Defaults to 2026-07-09T14:35:12.500Z

Fecha y hora de la solicitud en formato ISO 8601. En esta documentación se muestra un ejemplo precargado; al consumir la API debe enviarse la fecha/hora real de la solicitud.

string
required

Identificador único para la trazabilidad de la solicitud

string
enum
required

Identificador único del proceso interno de Forpay que realiza la solicitud

Allowed:
string
required

Identificador del ejecutivo que realiza la venta

string
required

Clave x-api-key

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json