Skip to content

Enums — /enums (descontinuado)

Endpoints públicos (🌐), todos GET, sem token. Servem para preencher selects e traduzir códigos de status na sua interface. Entrada: nenhuma (exceto /enums/banks).

Cada resposta é uma lista de pares — use o value nas chamadas à API e o rótulo na tela.

EndpointSaída
GET /enums/payment-methodArray { value, name } — métodos de pagamento.
GET /enums/user-statusArray { value, name } — status de usuário.
GET /enums/boleto-statusArray { value, name } — status de boleto.
GET /enums/pix-statusArray { value, name } — status de Pix.
GET /enums/webhook-typeArray { value, title } — tipos de evento de webhook.
GET /enums/webhook-statusArray { value, title } — status de entrega de webhook.
GET /enums/type-transactionsArray { id, slug, name } — tipos de transação.
GET /enums/status-clientsArray { id, ... } — status de cliente.
GET /enums/charge-statusArray { id, title, description } — status de cobrança.
GET /enums/status/payment_linksStatus de link de pagamento.
GET /enums/status/pix-withdrawArray { value, title, description } — status de saque Pix (na chave data).

GET /enums/banks

Entrada (query, todos opcionais): ispb, name, code, fullName, search (busca em nome / nome completo / código / ISPB). Saída: 200, chave banks = array de bancos ({ id, ispb, code, name, full_name, … }), message: "Bancos listados com sucesso."