Find (External ID)

Find Mandate (External ID)

Qué hace

Busca un mandato/deuda puntual y devuelve su estado e informacion asociada.

Cuándo usarlo

Usalo para conciliacion puntual, soporte o para validar el estado de un mandato ya creado. Para busquedas masivas usa GET /receivables.

Endpoint

GET /mandate/id/{mandateExternalId}

Autenticación

Requiere x-api-key y Authorization: Bearer <JWT>, salvo endpoints publicos de autenticacion o contratos de webhook receptor del cliente.

Parámetros para probar en OpenAPI

CampoDescripcion
mandateExternalIdID externo del mandato enviado por el comercio como mandate.id.

Reglas de negocio

  • El mandato debe pertenecer al comercio autenticado.
  • Usa el endpoint externo o interno segun el identificador que tengas disponible.

Respuesta exitosa

Retorna informacion del mandato encontrado. Si no existe o no pertenece al comercio, se retorna error de recurso no encontrado/no autorizado segun corresponda.

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

Identificador externo del mandato enviado por el comercio.

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