Consulta de extrato do estabelecimento

get https://sandbox.staging.justa.com.vc/payment-provider/api/sale-statement/{integratorId}/{legalDocument}

Respostas das requisições

Para esta consulta será retornada uma lista dos seguintes dados:

Variável	Tipo	Descrição
movements	List<.Object>	Contém as movimentações feitas
total	Integer	Contém a quantidade de categorias retornadas na lista de movimentações

Movements

Variável	Tipo	Descrição
date	String	Data de referência das movimentações
movementType	String	Tipo de movimentação
transactionType	String	Tipo da transação
valueCents	BigInteger	Valor com casas decimais de centavos, Ex.: 15000000 - 150.000,00
details	List<.Object>	Contém detalhes da movimentação

Details

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

Variável	Tipo	Descrição
authorizationCode	String	Código id junto ao provedor
nsu	String	Código adicional junto ao provedor
flag	String	Bandeira do cartão
referenceId	String	Id de referência da movimentação
transactionValue	BigInteger	Valor com casas decimais de centavos, Ex.: 15000000 - 150.000,00
mosStatus	String	Status da movimentação

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

Variável	Tipo	Descrição
authorizationCode	String	Código id junto ao provedor
nsu	String	Código adicional junto ao provedor
flag	String	Bandeira do cartão
movementId	String	ID da movimentação
movementStatus	String	Status da movimentação. Ex.: PAYED
movementValue	Integer	Valor da transação em centavos. Ex.: 500 equivalem à R$5,00

Path Params

integratorId

string

required

ID que identifica o integrador e é repassado pelo técnico responsável por sua integração

legalDocument

string

required

CPF/CNPJ do herói

Query Params

page

int32

Defaults to 0

Número da página desejada. A primeira página é 0

limit

int32

Defaults to 10

Quantidade de registros por página

periodTime

string

Defaults to FUTURE

Período em que o lojista deseja visualizar o seu extrato. Deve ser enviado como "FUTURE"

startDate

string

required

Data inicial para retornar os dados. Ex.: 2022-12-22(ano-mês-dia)

endDate

string

required

Data final para retornar os dados. Ex.: 2022-12-23(ano-mês-dia)

Headers

authorization

string

required

Defaults to Bearer {access_token}

Autenticação do tipo Bearer a ser enviada. O atributo {access_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


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.staging.justa.com.vc/payment-provider/api/sale-statement/integratorId/legalDocument?page=0&limit=10&periodTime=FUTURE' \
3
     --header 'accept: application/json' \
4
     --header 'authorization: Bearer {access_token}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Respostas das requisições​

📘

📘

200200

Respostas das requisições