Obter pagamentos

HML Env

https://tjscscpphml.thema.inf.br

GET

/infra/apigw/tributacao/scpp/processos/{chaveProcessoAdm}/pagamentos

Última modificação:2024-10-01 18:18:58

Este serviço permite consultar os pagamentos relacionados a um processo, usando a chave do processo para verificar se houve pagamento total ou parcial, além de fornecer detalhes sobre cada pagamento efetuado.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

chaveProcessoAdm

string

requerido

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Body

pagamentos

array[object (Pagamento) {9}]

requerido

codigoBanco

string

requerido

chaveProcesso

integer

requerido

dataPagamento

string

ISO 8601

requerido

Quando o devedor efetuou o pagamento no banco

Padrão de combinação:

YYYY-MM-DDTHH:mm:ssZ

dataCredito

string

ISO 8601

requerido

Quando o pagamento foi identificado

Padrão de combinação:

YYYY-MM-DDTHH:mm:ssZ

valorPago

number <float>

requerido

tipoPagamento

enum<string>

requerido

Indica se o pagamento é de parcelamento ou não

Valores permitidos:

N - Pagamento a vista

numeroParcela

integer

requerido

pagamentoTotal

enum<string>

requerido

Valores permitidos:

S - Pagamento totalN - Pagamento parcial

nossoNumero

string

requerido

Identificador do boleto pago

Exemplo

{
    "pagamentos": [
        {
            "codigoBanco": "001",
            "chaveProcesso": 123456,
            "dataPagamento": "2024-10-02T14:14:55-03:00",
            "dataCredito": "2024-10-02T14:14:55-03:00",
            "valorPago": 15.25,
            "tipoPagamento": "N",
            "numeroParcela": 0,
            "pagamentoTotal": "S",
            "nossoNumero": "80000000045"
        }
    ]
}

🟠400Requisição inválida

Modificado em 2024-10-01 18:18:58