Pular para o conteúdo principal

Pagamentos do aluno online

Pagamentos de uma matrícula online. Na tela, cada matrícula tem o botão Pagamentos em Alunos online, que mostra o valor total do curso, o total pago e o restante a pagar. Cada pagamento tem forma de pagamento, valor, data, número do documento e, quando informado, a quantidade de parcelas.

Todas as rotas usam o uuid da matrícula no caminho: {training_student_uuid}.

Endpoints​

MétodoCaminhoDescrição
GET/comercial/online-students/{training_student_uuid}/payment-methodsLista as formas de pagamento disponíveis (lista de apoio)
GET/comercial/online-students/{training_student_uuid}/paymentsLista os pagamentos da matrícula
POST/comercial/online-students/{training_student_uuid}/paymentsRegistra um pagamento
GET/comercial/online-students/{training_student_uuid}/payments/{id}Consulta um pagamento
PUT/comercial/online-students/{training_student_uuid}/payments/{id}Altera um pagamento
DELETE/comercial/online-students/{training_student_uuid}/payments/{id}Exclui um pagamento
POST/comercial/online-students/{training_student_uuid}/payments/concludeEnvia pagamentos selecionados para o financeiro
GET/comercial/online-students/{training_student_uuid}/payments/payment-receipt/{id?}Gera o recibo de pagamento (PDF)
GET/comercial/online-students/{training_student_uuid}/payments/studentsLista os cadastros de alunos do cliente (lista de apoio)

Listas de apoio​

GET /comercial/online-students/{training_student_uuid}/payment-methods​

Lista as formas de pagamento cadastradas no cliente, com a conta de cada uma. O id de cada item é o valor de payment_method_account_id ao registrar um pagamento.

Resposta: 200, lista com id, payment_method (nome da forma de pagamento) e account (conta).

GET /comercial/online-students/{training_student_uuid}/payments/students​

Lista os cadastros de alunos do cliente, com os mesmos filtros de GET /comercial/online-students/students.

Resposta: 200, lista de cadastros de alunos.

Consulta​

GET /comercial/online-students/{training_student_uuid}/payments​

Lista os pagamentos da matrícula.

Parâmetros de URL

ParâmetroDescrição
start_date e end_datePeríodo da data do pagamento. Com os dois, vale o intervalo. Com um só, vale a partir da data (start_date) ou até a data (end_date)
create_start_date e create_end_datePeríodo da data de registro do pagamento
column e orderColuna e sentido da ordenação
per_page e pagePaginação

Resposta: 200. Sem per_page, a resposta é uma lista simples. Com per_page, a resposta é paginada. Cada item traz id, date, amount, document_number, payment_method, account, initial_installment, final_installment, user_name e os dados da matrícula (course, student, student_start_date, student_end_date, student_amount).

GET /comercial/online-students/{training_student_uuid}/payments/{id}​

Devolve um pagamento da matrícula, com a matrícula associada.

Resposta: 200, com o pagamento.

Registro, alteração e exclusão​

POST /comercial/online-students/{training_student_uuid}/payments​

Registra um pagamento na matrícula.

O valor de cada pagamento é limitado ao restante a pagar. Se o valor informado for maior que o restante, o sistema registra o restante.

Com installment, o valor é dividido em parcelas, com vencimentos mensais a partir da data informada. A última parcela recebe a diferença de arredondamento. Cada parcela aparece como um pagamento separado, com initial_installment e final_installment preenchidos.

Corpo

CampoObrigatórioTipoDescrição
payment_method_account_idSimnúmeroid da forma de pagamento, da lista payment-methods
dateSimdataData do pagamento. Com parcelas, é a data da primeira parcela
amountSimnúmeroValor pago. Limitado ao restante a pagar
document_numberNãotextoNúmero do documento do pagamento
installmentNãonúmero inteiroQuantidade de parcelas. O valor é dividido entre elas

Resposta: 201, sem registro no corpo da resposta.

Exemplo

curl -X POST "https://api.pedagogo.app/comercial/online-students/<uuid-da-matricula>/payments" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_method_account_id": 7,
    "date": "2026-03-10",
    "amount": 1,
    "document_number": "NF-0001",
    "installment": 2
  }'

PUT /comercial/online-students/{training_student_uuid}/payments/{id}​

Altera um pagamento. O valor também é limitado ao restante a pagar, considerando o valor atual deste pagamento.

Corpo

CampoObrigatórioTipoDescrição
payment_method_account_idNãonúmeroid da forma de pagamento
dateNãodataData do pagamento
amountNãonúmeroValor pago
document_numberNãotextoNúmero do documento do pagamento

Resposta: 200, com true quando o pagamento foi salvo.

DELETE /comercial/online-students/{training_student_uuid}/payments/{id}​

Exclui um pagamento.

  • Um pagamento ainda não enviado ao financeiro pode ser excluído.
  • Um pagamento já enviado ao financeiro só é excluído quando o lançamento correspondente ainda está em aberto. A exclusão remove também o lançamento no financeiro.

Se a condição não for atendida, nada é removido.

Resposta: 200, sem corpo.

Envio para o financeiro​

POST /comercial/online-students/{training_student_uuid}/payments/conclude​

Envia os pagamentos selecionados para o financeiro. Para cada pagamento informado, é criado um lançamento a receber no módulo financeiro, com o valor, a data e a forma de pagamento do pagamento, e o pagamento passa a ficar vinculado a esse lançamento.

Corpo

CampoObrigatórioTipoDescrição
idsSimlista de númerosid dos pagamentos a enviar

Resposta: 200, sem corpo.

Recibo​

GET /comercial/online-students/{training_student_uuid}/payments/payment-receipt/{id?}​

Gera o recibo de pagamento em PDF. Com id, o recibo traz o pagamento informado. Sem id, o documento traz os pagamentos da matrícula que já estão no financeiro.

Resposta: 200, com o PDF.