Saltar al contenido principal
Los campos personalizados permiten que tu cuenta de comerciante almacene datos KYC/KYB que el modelo de entidad estándar no incluye, como la actividad comercial, la fuente de fondos, los volúmenes estimados o los identificadores locales. Localpayment define un esquema para tu comerciante y tú envías los valores en attributes cuando creas o actualizas una entidad.

Requisitos previos

  • Un esquema de campos personalizados acordado con tu gestor de cuenta y publicado por Localpayment.
  • Un token de acceso de Stage. Consulta Obtener token de acceso.

Cómo funciona

  • Sin esquema publicado: attributes se acepta tal como se envía, y Obtener esquema de campos personalizados devuelve 404 CUSTOM_FIELD_SCHEMA_NOT_FOUND.
  • Esquema publicado: la validación es estricta. Las claves desconocidas, las claves obligatorias ausentes, los tipos, longitudes, patrones y rangos incorrectos se rechazan con 400 CUSTOM_FIELDS_INVALID. Cada entidad registra el customFieldSchemaVersion con el que fue validada.
  • Un esquema por comerciante se aplica tanto a INDIVIDUAL como a COMPANY. Los campos que solo tienen sentido para empresas se definen como opcionales.

Tipos de campo

Las claves están en camelCase y comienzan con una letra minúscula (^[a-z][a-zA-Z0-9_]{0,63}$). attributes puede pesar hasta 64 KB (413 PAYLOAD_TOO_LARGE).

Lee el esquema

Request
Response
La respuesta predeterminada es un esquema JSON (2020-12). Agrega ?format=definition para obtener la lista de campos nativa.

Enviar los valores

Los valores se envían en attributes en Crear una entidad y Actualizar una entidad:
Un valor fuera del esquema devuelve 400 CUSTOM_FIELDS_INVALID, con una entrada por cada campo incorrecto en details:
Valida attributes contra el esquema de tu lado antes de llamar a la API, y asocia cada entrada de details con tu formulario para que el usuario pueda corregir el valor.

Cambiar el esquema

Localpayment publica los cambios de esquema como una nueva versión. Las entidades existentes conservan su customFieldSchemaVersion, y las nuevas escrituras se validan contra la última versión publicada. Pide a tu gestor de cuenta que agregue, flexibilice o elimine campos.
Una vez publicado un esquema, cualquier clave que no esté definida en él será rechazada. Coordina los cambios de esquema antes de enviar nuevos campos desde tu integración.

Próximos pasos

Obtener esquema de campos personalizados

Formatos de respuesta y códigos de error.

Compartir información KYB a través de entidades

Los campos personalizados utilizados para los beneficiarios de la cuenta virtual.
Última modificación el 10 de noviembre de 2026