Diccionario de datos

Glosario de 52 campos de la API Merchant de SPIDI, tomado de los esquemas del contrato.

Este archivo se genera automaticamente desde openapi/api-merchants-finantial.json. No lo edites a mano: vuelve a correr npm run gen:glosario.

Campo	Tipo	Descripcion
accessToken	string	Token JWT para usar en los headers Authorization.
address	string	Dirección del comercio.
affiliateCode	string
allowAmountChange	boolean	Si es true, permite editar el monto en el POS.
amountReference	number	Monto de referencia en la moneda especificada en currencyReference con 2 decimales.
authorizationCode	string	Código de autorización bancaria.
bankCode	string	Código del banco. Solo acepta 3–4 dígitos (p.ej., 105 o 0137).
bankId	string
batchNumber	integer	Este campo será un número autoincremental gestionado directamente desde el POS. El POS debe enviarlo para identificar correctamente el número de lote de las operaciones.
cancellationDara	object
cardTypeForRpt	string	Tipo de tarjeta (C=Crédito, D=Débito).
clientIdentification	string	Cédula o RIF del cliente.
closedAt	string
code	string	Código de activación (OTP) generado para el dispositivo POS.
commitAt	string	Fecha y hora de la confirmacion de la operacion (ISO 8601).
confirmData	object	Datos de confirmación bancaria. Este campo SOLO está definido y presente cuando el 'status' es 'PAID_COMPLETE'. En estados pendientes o cancelados, este campo será null o no existirá.
createdAt	string	Fecha y hora de creación en formato ISO 8601.
currencyReference	string	Moneda de referencia que se fija para el pago. Usada para calcular el monto en bolívares con la tasa vigente.
data	object	Representa una entidad única de negocio.
debitBatch	string	Falta ser definido por Carlos Cardenas
deeplinkConfig	object	Configuración para el retorno a la app (Deep Linking). Estos campos se usan cuando la app merchant se ubica en el punto, pues al terminar la transacción de compra, el app financiero va a abrir la app en la pantalla específica esperada por parte del merchant.
detail	string	Una explicación legible por humanos específica para esta ocurrencia del problema.
email	string	Dirección de correo electrónico.
errors	array	Lista de errores específicos de validación con punteros JSON (RFC 6901).
expiresIn	integer	Tiempo en segundos antes de expirar.
id	string	Identificador único en formato UUID del comercio
instance	string	Una referencia URI que identifica la ocurrencia específica del problema.
legalName	string	Nombre legal del comercio.
merchantId	string	Identificador único en formato UUID del comercio
message
number	string	Numero de terminal.
orderId	string	Identificador único de la orden generado por el comercio.
password	string	Contraseña de acceso del usuario.
phone	string	Número de teléfono.
pointer	string	Puntero al campo específico en el cuerpo de la solicitud.
processCode	string
returnActivity	string
returnPackage	string
secret_key	string	Clave secreta generada (ej. SHA-256) en el servidor vinculada al Serial, para autenticación mediante HMAC.
serial	string	Serial de Hardware del dispositivo POS.
status	integer	El código de estado HTTP generado por el servidor de origen.
taxId	string	RIF o identificación fiscal del comercio.
terminal	object
terminalNumber	string	Numero de terminal.
terminalSerial	string	Serial del terminal físico.
title	string	Un resumen breve y legible por humanos sobre el tipo de problema.
tokenType	string	Tipo de token de autenticación.
trace	string	Número de traza (Trace).
transactionCount	integer
type	string	Una referencia URI que identifica el tipo de problema.
utcDate	string	Timestamp UTC del banco.
visOrMccCard	string	Franquicia de la tarjeta.