Consulta pagamentos

HML Env

https://tjscscpphml.thema.inf.br

GET

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

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

Este serviço deve ser executado diariamente para buscar todos os pagamentos recebidos no dia anterior.

Recomendamos agendá-lo para 00:01, garantindo que todos os pagamentos do dia anterior sejam processados, evitando falhas ao carregar pagamentos após a consulta.

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

dataMovimento

string

requerido

Padrão de combinação:

yyyy-mm-dd

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Body

array of:

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

[
    {
        "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:53:18