Métodos de pagamento

Métodos de pagamento são os meios de pagamento e recebimento, como boleto, Pix ou cartão. Cada método é vinculado a uma categoria do plano de contas. Corresponde à aba Métodos de pagamento da tela Configurações do menu Financeiro. Os vínculos entre métodos e contas bancárias são descritos em Contas de métodos de pagamento.

Os endereços a seguir são relativos a https://api.pedagogo.app. Este recurso é identificado pelo uuid.

Endpoints

Método	Caminho	Descrição
GET	/financial/settings/payment-methods	Lista os métodos de pagamento
POST	/financial/settings/payment-methods	Cadastra um método de pagamento
GET	/financial/settings/payment-methods/{uuid}	Consulta um método de pagamento
PUT	/financial/settings/payment-methods/{uuid}	Altera um método de pagamento
DELETE	/financial/settings/payment-methods/{uuid}	Apaga um método de pagamento

Cadastrar

POST /financial/settings/payment-methods

Corpo

Campo	Obrigatório	Tipo	Descrição
payment_method	Sim	Texto	Nome do método de pagamento
category_id	Sim	Número	Categoria do plano de contas vinculada ao método (id de /financial/settings/categories)

Resposta (200): o método criado, com o uuid.

curl -X POST https://api.pedagogo.app/financial/settings/payment-methods \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"payment_method": "Pix exemplo", "category_id": 1}'

Listar

GET /financial/settings/payment-methods

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre. Busca no nome do método e no nome da categoria
withAccounts	Quando informado, a lista traz só os métodos que têm pelo menos uma conta vinculada
column e order	Ordena pela coluna informada e pelo sentido (asc ou desc). Sem eles, a lista vem em ordem de categoria
per_page e page	Paginação, conforme Convenções

Resposta (200): lista com uuid, payment_method, category_id, category e os nomes de quem criou e alterou o registro.

Consultar, alterar e apagar

GET /financial/settings/payment-methods/{uuid}

Devolve o método de pagamento com o uuid informado.

PUT /financial/settings/payment-methods/{uuid}

Altera um método. Envie somente os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
payment_method	Não	Texto	Nome do método de pagamento
category_id	Não	Número	Categoria do plano de contas

Resposta (200): o método alterado.

DELETE /financial/settings/payment-methods/{uuid}

Apaga o método de pagamento. Resposta 200, sem corpo.

Listas de apoio

As categorias usadas no campo category_id vêm de GET /financial/settings/categories, descrito em Categorias.