Skip to main content
GET
Devuelve la configuración de pagos que Fire tiene cargada para el vendor de tu API key, resuelta tienda por tienda: qué métodos ofrece cada una, dónde cobra cada uno y con qué valores. Cada entrada se basta a sí misma — no hay catálogo aparte contra el cual cruzar. Sin filtros trae todas las tiendas del vendor, paginadas. Con storeId o storeCode, una sola.
La respuesta incluye los valores de configuración, también los marcados como secretos (llaves de comercio, credenciales de datáfono). Trata esta respuesta como material sensible: no la registres en logs, no la caches en el navegador y no la reenvíes a terceros.
Esta es la v2. La v1 devuelve país → vendor → métodos con un enabled y sigue disponible, sin fecha de baja. La v2 cambia la fuente de los datos y agrega los niveles de tienda, canal, fulfillment y terminal.

​
Autenticación

​
string
requerido
Tu API key de Fire con el scope payment-methods:read. La key debe ser vendor-scoped (binding account + vendor) — las keys sin vendorId se rechazan con 403. El account y el vendor se resuelven desde la key: no se aceptan como query params.

​
Parámetros

​
string
UUID de la tienda en Fire. Excluyente con storeCode: mandar los dos devuelve 400.
​
string
El código externo de la tienda (EXTERNAL CODE en el backoffice). Es el identificador que probablemente ya tengas en tu propio maestro. No es ambiguo porque la API key fija el vendor.
​
string
Acota availability a un canal (por ejemplo KIOSK). Se compara en mayúsculas. Las tiendas que se quedan sin combinaciones para ese canal siguen apareciendo, sin métodos.
​
integer
predeterminado:"1"
Página de stores.
​
integer
predeterminado:"20"
Tiendas por página. Máximo 100.

​
Petición

​
Respuesta

​
boolean
Siempre true en un 200.
​
object

​
Cómo leer la respuesta

Para saber si mostrar un método en una tienda, mira charging. Es true cuando el método está activo en la cuenta y cobra en al menos una combinación de esa tienda. Para saber en qué canal y fulfillment cobra, mira availability. Una entrada con enabled: false significa “está configurada aquí, pero apagada ahora” —por ejemplo, el proveedor se cayó—. Es distinto de que no aparezca: lo que no aparece no se ofrece en esa tienda. Confundirlos se paga más adelante: si descartas las entradas pausadas, el día que el método se reanude tu lado lo va a leer como una combinación que nunca se configuró y va a reconfigurar lo que ya estaba puesto. Antes de intentar cobrar, mira missingRequiredKeys. Si trae algo, faltan datos obligatorios y el cobro va a fallar del lado del proveedor. devices casi siempre viene vacío. Aparece cuando un terminal puntual tiene una excepción —se rompió el datáfono de un kiosco y se apagó solo ese equipo, sin tocar los demás del local—. Si tu integración no distingue terminales, puedes ignorarlo: el nivel de tienda es la respuesta correcta para un canal de venta.

​
Notas

  • Identifica los métodos por methodId, nunca por code. Un código solo es único dentro de un país, y un vendor con tiendas en dos países puede definir el mismo código dos veces, con id distinto.
  • fulfillmentCode se devuelve tal como está guardado, sin normalizar contra el catálogo global.
  • Los métodos con active: false viajan igual, para que puedas mostrarlos como “no disponible” o esconderlos — es tu decisión.
  • Pedir una tienda que no pertenece al vendor de tu key devuelve 404, no 403.

​
Relacionado

Configuración de métodos de pago (v1)

La versión anterior, sin niveles de tienda. Sigue disponible.

Configuración de canales

Qué canales y fulfillments tiene habilitados tu vendor.