Extrato de recebíveis

Este endpoint tem como objetivo fazer a busca de todos os recebíveis de um lojista específico.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Respostas das requisições​

O retorno da requisição é uma lista paginada, onde o conteúdo da lista se encontra no atributo movements:

VariávelTipoDescrição
movementsList<.Object>Contém a listagem dos extratos
totalIntegerContém a quantidade de categorias retornadas na lista de movimentações

Movements

VariávelTipoDescrição
dateStringData da transação
movementTypeStringTipo da movimentação. Ex.: CREDIT
transactionTypeStringTipo do produto usado na transação. Ex.: PIX, WEB
valueCentsIntegerValor da transação em centavos. Ex.: 500 equivalem à R$5,00
detailsLista<.Object>Lista com detalhes de como a transação foi paga

Details

📘

Caso o retorno seja do tipo "WEB", estes são os detalhes retornados da transação:

VariávelTipoDescrição
authorizationCodeStringCódigo id junto ao provedor
nsuStringCódigo adicional junto ao provedor
flagStringBandeira do cartão
referenceIdStringId de referência da movimentação
transactionValueBigIntegerValor com casas decimais de centavos, Ex.: 15000000 - 150.000,00
movementStatusStringStatus do processo de liquidação da transferência (PENDING, PROCESSING_PAYMENT, PAID)
installmentBigIntegerNúmero da parcela da movimentação
descriptionStringDescrição contendo detalhes sobre o movimento, como bandeira, parcelamento parcial e total
txIdBigIntegerIdentificador único da transação (o mesmo retornado no extrato transacional)
txDateTimeDateTimeA taxa em que aconteceu a transação (o mesmo retornado no extrato transacional)

📘

Caso o retorno seja do tipo "POS_DEBIT" OU "POS_CREDIT", este será o retorno dos detalhes:

VariávelTipoDescrição
authorizationCodeStringCódigo id junto ao provedor
nsuStringCódigo adicional junto ao provedor
flagStringBandeira do cartão
movementIdStringID da movimentação
movementStatusStringStatus do processo de liquidação da transferência (PENDING, PROCESSING_PAYMENT, PAID)
movementValueIntegerValor da transação em centavos. Ex.: 500 equivalem à R$5,00
txIdBigIntegerIdentificador único da transação (o mesmo retornado no extrato transacional)
txDateTimeDateTimeA taxa em que aconteceu a transação (o mesmo retornado no extrato transacional)
installmentBigIntegerNúmero da parcela da movimentação
descriptionStringDescrição contendo detalhes sobre o movimento, como bandeira, parcelamento parcial e total
Path Params
string
required
Defaults to 123456789101

CPF/CNPJ do lojista

Query Params
int32
required
Defaults to 0

Página atual a ser buscada. Começa com 0

int32
required
Defaults to 10

Quantidade de transações por página

string
required
Defaults to 2022-07-01

Data inicial para busca das transações

string
required
Defaults to 2022-07-20

Data final para busca das transações

Headers
string
required
Defaults to Bearer {token}

Autenticação do tipo Bearer a ser enviada. O atributo {token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json