Find (Internal ID)

Find Mandate (Internal 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/internalId/{mandateId}

Autenticación

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

Campos principales

CampoDescripcion
mandateIdID interno Forpay del mandato.

Reglas de negocio

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

Respuesta exitosa

HTTP 200 con message=MANDATE_DETAIL_OK. El campo exterior payload contiene la respuesta del flujo, con su propio statusCode, message, code, name y payload.

Los datos se consultan en payload.payload.businessPartner, payload.payload.customer, payload.payload.mandate y payload.payload.installments. customer.userId puede estar ausente cuando el cliente carece de identificador externo. El medio asociado, cuando está disponible, se encuentra en payload.payload.mandate.paymentMethod. Su ID corresponde a la clasificación de salida de esta operación.

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

Identificador interno Forpay del mandato.

Headers
string
enum
required

Identificador de país donde proviene la solicitud

Allowed:
string
required
length between 5 and 30

Identificador único del comercio asociado definido por forpay

string
required
length ≥ 3

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
length ≥ 1

Identificador de trazabilidad obligatorio. Se recomienda usar un UUID único por solicitud.

string
required
length ≥ 5

Proceso de la solicitud. Para el flujo de nuevas integraciones documentado, utiliza HYBRID.

string
required
length ≥ 1

Identificador del ejecutivo que realiza la venta

string
required

Clave x-api-key

Response

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