Contas de métodos de pagamento

Registra quais contas bancárias recebem cada método de pagamento. Cada vínculo liga um método de pagamento a uma conta cadastrada em Contas. Corresponde à tabela Contas de métodos de pagamento, na aba Métodos de pagamento da tela Configurações do menu Financeiro.

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

Endpoints

Método	Caminho	Descrição
GET	/financial/settings/payment-methods-accounts	Lista os vínculos
POST	/financial/settings/payment-methods-accounts	Cria um vínculo
GET	/financial/settings/payment-methods-accounts/{id}	Consulta um vínculo
PUT	/financial/settings/payment-methods-accounts/{id}	Altera um vínculo
DELETE	/financial/settings/payment-methods-accounts/{id}	Apaga um vínculo
GET	/financial/settings/accounts	Contas cadastradas (lista de apoio)

Cadastrar

POST /financial/settings/payment-methods-accounts

Se já existir um vínculo igual, entre o mesmo método e a mesma conta, a resposta traz o vínculo existente. Se o vínculo tiver sido apagado antes, ele é reativado com os dados enviados.

Corpo

Campo	Obrigatório	Tipo	Descrição
payment_method_id	Sim	Número	Método de pagamento (id de /financial/settings/payment-methods)
account_id	Sim	Número	Conta bancária (id de /financial/settings/accounts)

Resposta (200): o vínculo criado ou o existente.

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

Listar

GET /financial/settings/payment-methods-accounts

Parâmetros de URL

Parâmetro	Descrição
payment_method_id	Filtra pelo método de pagamento (id)
payment_method_uuid	Filtra pelo método de pagamento (uuid)
search	Texto livre. Busca no nome do método e no nome da conta
column e order	Ordena pela coluna informada e pelo sentido (asc ou desc)
per_page e page	Paginação, conforme Convenções

Resposta (200): lista de vínculos, com id, payment_method_id, account_id, o nome do método e o nome da conta.

Consultar, alterar e apagar

GET /financial/settings/payment-methods-accounts/{id}

Devolve o vínculo com o id informado.

PUT /financial/settings/payment-methods-accounts/{id}

Altera o vínculo.

Corpo

Campo	Obrigatório	Tipo	Descrição
payment_method_id	Sim	Número	Método de pagamento
account_id	Sim	Número	Conta bancária

Resposta (200): o vínculo alterado.

DELETE /financial/settings/payment-methods-accounts/{id}

Remove o vínculo. Resposta 200, sem corpo.

Listas de apoio

GET /financial/settings/accounts

Contas cadastradas, para o campo Conta bancária. O conteúdo é o mesmo de GET /financial/accounts, descrito em Contas.