Skip to main content
GET
Devolve a configuração de pagamentos que a Fire tem cadastrada para o vendor da sua API key, resolvida loja por loja: quais formas cada uma oferece, onde cada uma cobra e com quais valores. Cada entrada se basta — não há catálogo à parte para cruzar. Sem filtro, traz todas as lojas do vendor, paginadas. Com storeId ou storeCode, apenas uma.
A resposta inclui os valores de configuração, inclusive os marcados como secretos (chaves de estabelecimento, credenciais de maquininha). Trate esta resposta como material sensível: não registre em logs, não guarde em cache no navegador e não repasse a terceiros.
Esta é a v2. A v1 devolve país → vendor → formas com um enabled e continua disponível, sem data de desativação. A v2 muda a origem dos dados e acrescenta os níveis de loja, canal, fulfillment e terminal.

​
Autenticação

​
string
obrigatório
Sua API key da Fire com o escopo payment-methods:read. A key precisa ser vendor-scoped (binding account + vendor) — keys sem vendorId são rejeitadas com 403. A conta e o vendor são resolvidos a partir da key: não são aceitos como query params.

​
Parâmetros

​
string
UUID da loja na Fire. Excludente com storeCode: enviar os dois devolve 400.
​
string
O código externo da loja (EXTERNAL CODE no backoffice). É o identificador que você provavelmente já tem no seu próprio cadastro. Não é ambíguo porque a API key fixa o vendor.
​
string
Restringe availability a um canal (por exemplo KIOSK). Comparado em maiúsculas. As lojas que ficam sem combinações para esse canal continuam aparecendo, sem formas de pagamento.
​
integer
padrão:"1"
Página de stores.
​
integer
padrão:"20"
Lojas por página. Máximo 100.

​
Requisição

​
Resposta

​
boolean
Sempre true em um 200.
​
object

​
Como ler a resposta

Para saber se deve exibir uma forma numa loja, olhe charging. É true quando a forma está ativa na conta e cobra em pelo menos uma combinação daquela loja. Para saber em qual canal e fulfillment ela cobra, olhe availability. Uma entrada com enabled: false significa “está configurada aqui, mas desligada agora” — o provedor caiu, por exemplo. É diferente de não aparecer: o que não aparece não é oferecido naquela loja. Confundir os dois se paga depois: se você descartar as entradas pausadas, no dia em que a forma for retomada o seu lado vai lê-la como uma combinação que nunca foi configurada e vai reconfigurar o que já estava lá. Antes de tentar cobrar, olhe missingRequiredKeys. Se trouxer algo, faltam dados obrigatórios e a cobrança vai falhar do lado do provedor. devices quase sempre vem vazio. Aparece quando um terminal específico tem uma exceção — a maquininha de um quiosque quebrou e só aquele equipamento foi desligado, sem mexer nos demais da loja. Se a sua integração não distingue terminais, pode ignorar: o nível de loja é a resposta correta para um canal de venda.

​
Notas

  • Identifique as formas por methodId, nunca por code. Um código só é único dentro de um país, e um vendor com lojas em dois países pode definir o mesmo código duas vezes, com id diferente.
  • fulfillmentCode é devolvido exatamente como está guardado, sem normalizar contra o catálogo global.
  • As formas com active: false viajam do mesmo jeito, para você exibi-las como “indisponível” ou escondê-las — a decisão é sua.
  • Pedir uma loja que não pertence ao vendor da sua key devolve 404, não 403.

​
Relacionado

Configuração de formas de pagamento (v1)

A versão anterior, sem níveis de loja. Continua disponível.

Configuração de canais

Quais canais e fulfillments o seu vendor tem habilitados.