API Reference
Log In

Extrato de recebíveis

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

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
Language
Click Try It! to start a request and see the response here!