Procesadores del comercio

Obtener procesador

GET /v1/acquirers/merchants

Este endpoint devuelve el formulario de un procesador para un comercio y un tipo de tasa. Tiene dos usos:

  • Antes del registro: indica los datos requeridos para registrar el comercio.
  • Después del registro: cada campo incluye en properties.value el dato guardado, y la respuesta sirve como base para actualizar el comercio.

Datos de consulta

ParámetrosDescripción
merchantId
  • string
  • Identificador del comercio
acquirerId
  • string
  • Identificador del procesador
  • [GPS, PRISMA, PRISMA_QR, BANORTE, AMEX, DEPAY, PROSA, BROXEL, WUZI]
rateType
  • string
  • Tipo de tasa a utilizar
  • [AGGREGATOR, NATURAL]
ℹ️

Datos de respuesta

ParámetrosDescripción
acquirer_id
  • string
  • Identificador de la adquirencia
  • [GPS, PRISMA, PRISMA_QR, BANORTE, AMEX, DEPAY, PROSA, BROXEL, WUZI]
customer_id
  • string
  • Identificador único del cliente al cual estará vinculado el comercio en el sistema
merchant_id
  • string
  • Identificador único del comercio que se desea registrar
rate_type
  • string
  • Tipo de tasa aplicada a las transacciones del comercio
  • [AGGREGATOR, NATURAL]
payment_type
  • string
  • Tipo de pago
  • [TERMINAL, QR, PAYMENT_LINK]
data
  • list
  • Es una lista que contiene los distintos campos necesarios para completar el registro del comercio. Cada campo en data representa un input del formulario, y su estructura es flexible para adaptarse a la complejidad y profundidad de los datos requeridos.
  • data.
name
  • string
  • El nombre del campo que se necesita completar. Este nombre ayuda a identificar el propósito de cada campo en el formulario.
  • data.
properties
  • object
  • Contiene las propiedades específicas del campo que definen cómo debe mostrarse y comportarse en el formulario.
  • data.properties.
type
  • (opcional)
  • string
  • Define el tipo de input, como TEXT (campo de texto), AUTOCOMPLETE (sugerencia automática), SELECT (menú desplegable), OBJECT (estructura compleja que contiene otros inputs), MULTISELECT (selección múltiple, usa properties.values) y LIST
  • [TEXT, AUTOCOMPLETE, SELECT, OBJECT, MULTISELECT, LIST]
  • data.properties.
title
  • (opcional)
  • string
  • El título o etiqueta que describe el campo en el formulario.
  • data.properties.
description
  • (opcional)
  • string
  • Una breve descripción del campo, que puede usarse como una pista para el usuario.
  • data.properties.
validations
  • (opcional)
  • object
  • Validaciones que se aplican al input
  • data.properties.validations.
required
  • boolean
  • Indica si el campo es obligatorio (true) o no (false)
  • data.properties.
href
  • (opcional)
  • string
  • URL donde se puede obtener información adicional para completar el campo. Por ejemplo, una lista de actividades o tipos de documentos en formato KEY/VALUE.
  • data.properties.
hidden
  • (opcional)
  • boolean
  • Indica si el campo debe estar oculto en el formulario (true) o visible (false).
  • data.properties.
value
  • (opcional)
  • string
  • Valor del campo. Si el comercio ya está registrado en el procesador, contiene el dato guardado. Si no está presente, significa que el input aún no tiene un valor asignado.
  • data.properties.
data
  • (opcional)
  • list
  • Contiene campos adicionales cuando el tipo de input es OBJECT, permitiendo la recursión en la estructura. Esto se utiliza cuando se necesita un conjunto de inputs anidados. Cada input dentro de properties.data sigue la misma estructura recursiva, permitiendo formularios de múltiples niveles de profundidad.
  • data.properties.
options
  • (opcional)
  • list
  • Lista de opciones en formato KEY/VALUE para campos de tipo SELECT o AUTOCOMPLETE
  • data.properties.
values
  • (opcional)
  • list
  • Lista de valores seleccionados para campos de tipo MULTISELECT
  • data.properties.
readonly
  • (opcional)
  • boolean
  • Indica que el campo es de solo lectura. No debe enviarse al registrar el comercio
curl --request GET \
  --url 'https://api.menta.global/api/v1/acquirers/merchants?merchantId={merchant_id}&acquirerId={acquirer_id}&rateType={rate_type}' \
  --header 'Authorization: Bearer {access_token}'
{
    "acquirer_id": "string",
    "customer_id": "string",
    "merchant_id": "string",
    "rate_type": "string",
    "payment_type": "string",
    "data": [
        {
            "name": "string",
            "properties": {
                "type": "string",
                "title": "string",
                "description": "string",
                "validations": {
                    "required": "boolean"
                },
                "href": "string",
                "hidden": "boolean",
                "value": "string",
                "data": "list",
                "options": "list"
            }
        }
    ]
}