Geração do link de pagamento de parcelas

Autorização

apikey

apikey<token>

Chave única da IES para consumir a API/endpoint.

Local: header

Corpo da Requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

alunoCpf?string

CPF do Aluno. Se o campo alunoRa não for enviado, é obrigatório enviar o CPF do Aluno.

alunoRa?string

Registro do Aluno no sistema da instituição (ID único do aluno). Se o campo alunoCpf não for enviado, é obrigatório enviar o RA do Aluno.

responsavelFinanceiroDocumento*string

CPF ou CNPJ do Responsável Financeiro.

parcelaOriginalIdExterno*string

Id (código único) da parcela original no sistema utilizado pela instituição de ensino. Essa informação deve ser enviada no momento da criação da parcela.

Corpo da Resposta

`application/json`

curl -X POST "https://example.com/v1/parcela/link_pagamento" \  -H "Content-Type: application/json" \  -d '{    "responsavelFinanceiroDocumento": "58369589049",    "parcelaOriginalIdExterno": "749233"  }'

{  "link_pagamento_url": "string",  "parcela_original_id_externo": 0}

Geração do link de pagamento de parcelas

Autorização

Corpo da Requisição

Corpo da Resposta

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`