Ferramentas - API WyzeCash

Documentação (sem chave)

Ferramenta	O que faz	Parâmetros
`listar_operacoes`	Todas as rotas da API, por grupo, com a permissão de cada uma	`grupo`, `busca` (opcionais)
`ver_operacao`	Método, caminho, permissão, campos aceitos (tirados do esquema da rota), regras, exemplo de pedido e de resposta	`operacao` (ex.: `criar_cobranca`)
`exemplo_codigo`	O pedido pronto, com a chave em variável de ambiente	`operacao`, `linguagem` (`curl`, `node`, `python` ou `php`)
`buscar_documentacao`	Webhooks e assinatura, cobranças, erros, idempotência, limites, permissões, saques, subcontas, MED e tarifas	`busca` (opcional; sem ela, lista os temas)
`testar_chave`	Se a chave vale, de qual conta é, as permissões e as ferramentas que ela libera. Nunca mostra o segredo	nenhum

Sua conta (com a chave de API)

Aparecem só as ferramentas que a chave pode usar. Os campos de cada uma são os mesmos da rota da API.

Ferramenta	Rota	Permissão
`criar_cobranca`	`POST /v1/payments`	`/payments/create` (Pix), `/payments/create-card` (cartão) ou `/payments/create-crypto` (cripto)
`formas_de_pagamento`	`GET /v1/payments/methods`	uma das três acima
`listar_cobrancas`	`GET /v1/payments`	`/payments/list`
`consultar_cobranca`	`GET /v1/payments/:id`	`/payments/get`
`criar_link`	`POST /v1/payment-links`	`/payment-links/create`
`listar_links`	`GET /v1/payment-links`	`/payment-links/list`
`consultar_link`	`GET /v1/payment-links/:id`	`/payment-links/get`
`listar_clientes`	`GET /v1/customers`	`/customers/list`
`saldo`	`GET /v1/balance`	`/account/balance`
`tarifas`	`GET /v1/fees`	`/account/fees`
`previa_tarifa`	`GET /v1/fees/preview`	`/account/fees`
`extrato`	`GET /v1/statement`	`/account/statement`
`comprovante`	`GET /v1/receipts/:id`	`/receipts/get`
`listar_meds`	`GET /v1/meds`	`/meds/list`
`listar_subcontas`	`GET /v1/subaccounts`	`/subaccounts/list`
`consultar_subconta`	`GET /v1/subaccounts/:id`	`/subaccounts/get`

criar_cobranca e criar_link aceitam também idempotencyKey: mande o código do pedido para a cobrança não sair duas vezes.

Só na documentação

O que tira dinheiro nunca vira ferramenta, nem com a chave: Pix enviado, saque, estorno e o que mexe no saldo das subcontas (enviar, transferir, devolver e sacar). Essas rotas aparecem em listar_operacoes, ver_operacao e exemplo_codigo, marcadas como “tira dinheiro”, para você rodar no seu sistema.

Erros

O que a API recusaria volta como erro da ferramenta (isError), com a situação, o código e a mensagem em português:

Erro 403 FORBIDDEN: Você não tem permissão para isso.

Os códigos são os mesmos da API: veja Erros.