Listar compras passíveis de antecipação

Use esse endpoint para listar compras passíveis de antecipação realizadas no período escolhido.

Serviço exclusivo para processadora Dock.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/lancamentos/compras-antecipaveis?dataInicio&dataFim&page&size&sort&idPortador' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'

{ "content": [ { "idCompra": 2001, "status": "Processada", "dataCompra": "2023-05-06T10:06:00.000+0000", "valorTotalCompra": 109.75, "valorParcela": 10.98, "primeiraParcela": 10.98, "numeroParcelas": 10, "numeroParcelasAntecipaveis": 4, "nomeEstabelecimento": "NOME ESTABELECIMENTO", "idPortador": 106, "idProduto": 1, "descricaoProduto": "PRODUTO", "cartao": "2001XXXXXXXX2001", "nomePortadorCartao": "REGICLEA SALVIANO", "tipoEvento": "Sem juros" }, { "idCompra": 2002, "status": "Processada", "dataCompra": "2023-05-11T07:06:00.000+0000", "valorTotalCompra": 151.57, "valorParcela": 12.63, "primeiraParcela": 12.63, "numeroParcelas": 12, "numeroParcelasAntecipaveis": 6, "nomeEstabelecimento": "NOME ESTABELECIMENTO", "idPortador": 106, "idProduto": 1, "descricaoProduto": "PRODUTO", "cartao": "2001XXXXXXXX2001", "nomePortadorCartao": "REGICLEA TESTE", "tipoEvento": "Sem juros" } ], "last": true, "nextPage": 0, "number": 0, "numberOfElements": 2, "size": 50, "totalElements": 2, "totalPages": 1, "first": true }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Query

dataInicio

string <date>

requerido

A data inicial do período a ser pesquisado, no formato YYYY-MM-dd.

Padrão:

2024-07-15

Exemplo:

2024-07-15

dataFim

string <date>

requerido

A data final do período a ser pesquisado, no formato YYYY-MM-dd.

Padrão:

2024-07-18

Exemplo:

2024-07-18

page

integer <int32>

opcional

O número da página.

Padrão:

Exemplo:

size

integer <int32>

opcional

A quantidade de registros retornados por página.

Padrão:

Exemplo:

sort

string

opcional

O tipo de ordenação.

Padrão:

string

Exemplo:

string

idPortador

integer <int64>

requerido

Identificador do portador.

Padrão:

2001

Exemplo:

2001

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Respostas

🟢200OK

application/json

Body

content

array [object {15}]

opcional

idCompra

integer

opcional

Identificador de compra.

Exemplo:

2001

status

string

opcional

status do lançamento.

Exemplo:

Processada

dataCompra

string

opcional

Data e hora da compra.

Exemplo:

2023-05-06T10:06:00.000+0000

valorTotalCompra

number

opcional

Valor total da compra.

Exemplo:

109.75

valorParcela

number

opcional

Valor da parcela

Exemplo:

10.98

primeiraParcela

number

opcional

Valor da primeira parcela.

Exemplo:

10.98

numeroParcelas

integer

opcional

Número de parcelas.

Exemplo:

numeroParcelasAntecipaveis

integer

opcional

Número de parcelas antecipáveis.

Exemplo:

nomeEstabelecimento

string

opcional

Nome do estalebecimento.

Exemplo:

NOME ESTABELECIMENTO

idPortador

integer

opcional

Identificador do portador.

Exemplo:

106

idProduto

integer

opcional

Identificador do produto.

Exemplo:

descricaoProduto

string

opcional

Descrição do produto.

Exemplo:

PRODUTO

cartao

string

opcional

Número do cartão mascarado.

Exemplo:

PRODUTO

nomePortadorCartao

string

opcional

Nome do portador do cartão.

Exemplo:

REGICLEA SALVIANO

tipoEvento

string

opcional

Tipo de evento

Exemplo:

Sem juros

last

boolean

opcional

Indica se é a última página.

integer

opcional

Próxima página.

Exemplo:

number

integer

opcional

Número da página atual.

Exemplo:

numberOfElements

integer

opcional

Quantidade de elementos na página.

Exemplo:

size

integer

opcional

Quantidade de registros por página.

Exemplo:

totalElements

integer

opcional

Total de elementos.

Exemplo:

totalPages

integer

opcional

Total de páginas.

Exemplo:

first

boolean

opcional

Indica se é a primeira página.

Padrão:

true

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor