Este projeto é um desafio técnico que propõe o desenvolvimento de uma API que permite a recepção e pagamentos de débitos, tanto de pessoa física como de pessoa jurídica.
- Cadastrar um pagamento.
- Atualizar o pagamento de pendente para Sucesso ou Falha.
- Listar todos os pagamentos.
- Filtrar pagamentos por CPF/CPNJ, Código do Débito ou Status do pagamento.
POST /api/pagamento
Body | Type | Description |
---|---|---|
codigoDebito |
String |
Required. Código do débito a ser pago |
tipoDocPagador |
String |
Required. CPF ou CNPJ |
metodoPagamento |
ENUM (BOLETO, PIX, CARTAO_CREDITO, CARTAO_DEBITO |
Required. Opções para pagamento |
numeroCartao |
String Cartao do credito/debito válido |
Requaired se o pagamento for com cartão. |
valorPagamento |
String |
Required. Valor do débito a ser pago |
{
"data": "Pagamento",
"httpStatus": "CREATED",
"message": "Pagamento cadastrado com sucesso!"
}
PUT /api/processamento
body | Type | Description |
---|---|---|
id |
Long |
Required. ID do pagamento a ser atualizado |
statusPagamento |
String |
Required. Aceita somente (PENDENTE, SUCESSO, FALHA) |
{
"data": "Pagamento",
"httpStatus": "OK",
"message": "Pagamento atualizado com sucesso!"
}
GET /api/pagamento
{
"data": ["pagamentos"],
"httpStatus": "OK",
"message": "Todos os pagamentos listados com sucesso!"
}
GET /api/pagamento/filtro-codigoDebito/{codigoDebito}
PATH PARAM | Type | Description |
---|---|---|
codigoDebito |
String |
Required. Código do débito a ser filtrado |
{
"data": "pagamentos filtrados",
"httpStatus": "OK",
"message": "Pagamentos filtrados com sucesso"
}
GET /api/pagamento/filtro-cpfCnpj/{CpfCnpj}
PATH PARAM | Type | Description |
---|---|---|
cpfCnpj |
String |
Required. CPF/CNPJ a ser filtrado |
{
"data": "Array de pagamentos filtrados",
"httpStatus": "OK",
"message": "Pagamentos filtrados com sucesso"
}
GET /api/pagamento/filtro-status/{status}
PATH PARAM | Type | Description |
---|---|---|
status |
String |
Required. Status dos pagamentos a serem filtrados |
status precisa ser uma String do tipo 'PENDENTE' , 'SUCESSO' ou 'FALHA'
{
"data": "Array de pagamentos filtrados",
"httpStatus": "OK",
"message": "Pagamentos filtrados com sucesso"
}
Clone o projeto
git clone https://github.com/Daivison-Morais/Api-pagamentos-debitos.git
Navegue até o Diretório do Projeto
cd Api-pagamentos-debitos/