GET /collection-method

Devuelve todos los puntos de cobro configurados en Yappy Comercial para el comercio autenticado, junto a su tipo y detalles específicos.

Este endpoint es especialmente útil para:

Obtener los nombres exactos de tus puntos de cobro antes de usarlos como filtro en /movement/history.
Auditar qué métodos de cobro tiene activos tu comercio.
Identificar los deviceId de tus unidades de Yappy en Caja.

Request

GET {{BASE_URL}}/collection-method
api-key: {tu-api-key}
secret-key: {tu-clave-secreta}
authorization: {token-jwt}

No requiere body ni parámetros.

Response — 200 OK

{
  "status": {
    "code": "YP-0000",
    "description": "Se ha realizado la ejecución del servicio correctamente"
  },
  "body": {
    "collections": [
      {
        "alias": "techgeeks",
        "type": "Directorio"
      },
      {
        "alias": "Ventas en sitio",
        "type": "Punto Yappy"
      },
      {
        "alias": "Sucursal Multiplaza",
        "type": "Integración Yappy",
        "details": [
          { "id": "provided_group_id", "value": "smultiplaza" },
          { "id": "deviceId", "value": "smultiplaza-01" },
          { "id": "deviceId", "value": "smultiplaza-02" }
        ]
      },
      {
        "alias": "Sitio web",
        "type": "Boton de Pago",
        "details": [
          { "id": "url", "value": "https://www.micomercio.com" }
        ]
      }
    ]
  }
}

Diccionario de campos

Campo	Tipo	Descripción
`alias`	string	Nombre del punto de cobro. Es el valor exacto que debes usar en el filtro `COLLECTION_ALIAS` de `/movement/history`.
`type`	string	Tipo de punto de cobro — ver tabla de tipos a continuación.
`details`	array · opcional	Detalles específicos según el tipo. `Directorio` y `Punto Yappy` generalmente no incluyen `details`.
`details[].id`	string	Identificador del detalle: `url`, `provided_group_id` o `deviceId`.
`details[].value`	string	Valor del detalle correspondiente.

Tipos de punto de cobro

Tipo (`type`)	Descripción	Detalles incluidos
`Boton de Pago`	Punto de cobro web configurado con una URL.	`url` — la URL del sitio del comercio
`Integración Yappy`	Grupo de Yappy en Caja con sus unidades físicas.	`provided_group_id` (ID del grupo) + uno o más `deviceId` por caja
`Punto Yappy`	Punto de cobro visual dentro del portal de Yappy.	Sin `details` en los casos observados
`Directorio`	Entrada en el directorio de comercios de Yappy.	Sin `details` en los casos observados

Múltiples unidades por grupo

Un punto de cobro de tipo Integración Yappy (Yappy en Caja) puede tener varios deviceId — uno por cada caja física configurada dentro de ese grupo. Por ejemplo, una sucursal con 5 cajas tendrá 5 entradas deviceId bajo el mismo alias.

El alias es case-sensitive

Al usar el alias como valor de filtro en /movement/history, el valor debe coincidir exactamente — incluyendo mayúsculas, minúsculas y espacios — con lo que devuelve este endpoint.

Errores posibles

Código	Significado
`YP-0000`	Éxito. Si no hay puntos de cobro configurados, `collections` vendrá vacío.
`YP-0008`	Faltan headers obligatorios.
`YP-0002`	Error genérico de plataforma.

¿Te fue útil esta página?