Consulta de fatura por período

Este endpoint permite que o cliente do parceiro Bankly consulte todas as faturas de um determinado período (initialDate e finalDate), independentemente do seu status.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

Tenha sido aprovado na análise de crédito;
Tenha pelo menos um um cartão emitido.

Requisição (Request)

Requisição HTTP

GET 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}?initialDate={initialDate}&finalDate={finalDate}' \

--request GET \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}?initialDate={initialDate}&finalDate={finalDate}' \ 
--header 'Authorization:  Bearer {Token}'\ 
--header 'accept: application/json' \ 
--header 'api-version:  1.0'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`invoice.read`	Concede acesso para realizar consultas referente à gestão de faturas.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição, envie os seguintes campos:

Nome	Tipo	Descrição	Especificação
`documentNumber`	`path`	Obrigatório. Número do documento do titular do cartão (CPF ou CNPJ).	Informe apenas números, sem caracteres especiais.
`proxy`	`path`	Obrigatório. Código identificador do cartão.	—
`initialDate`	`query`	Obrigatório. Data inicial, referente ao vencimento da fatura, para a consulta.	Formato YYYY-MM-DD.
`finalDate`	`query`	Obrigatório. Data final, referente ao vencimento da fatura, para a consulta.	Formato YYYY-MM-DD.

❗️
Importante
O período máximo a ser informado entre a data inicial (initialDate) e a data final (finalDate) deverá ser de um ano.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso e retornará uma lista com todas as faturas.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`statements[]`	`array of objects`	Lista de objetos contendo informações sobre todas as faturas de um determinado período.
`statements[].statementId`	`integer`	Identificador único da fatura.
`statements[].month`	`integer`	Mês de vencimento da fatura.
`statements[].year`	`integer`	Ano de vencimento da fatura.
`statements[].cycle`	`integer`	Indicador do ciclo da fatura (por contrato de crédito).
`statements[].dueDate`	`string`	Data de vencimento da fatura, no formato ISO 8601 - UTC.
`statements[].amountMinimal`	`number`	Valor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura.
`statements[].balance`	`number`	Valor total da fatura.
`statements[].cycleType`	`string`	Situação da fatura, que pode ser “Open” (fatura aberta), “Future” (fatura futura), “Closed” (fatura fechada) e “DueDate” (fatura atrasada).
`statements[].paymentStatus`	`string`	Situação do pagamento da fatura, que pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).
`statements[].paymentTotalAmount`	`number`	Valor pago.

{
   "statements": [
      {
         "statementId": 0,
         "month": 0,
         "year": 0,
         "cycle": 0,
         "dueDate": "2022-10-25T17:27:37.257Z",
         "amountMinimal": 0,
         "balance": 0,
         "cycleType": "Open",
         "paymentStatus": "Pending",
         "paymentTotalAmount": 0
      }
   ]
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar alguns erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
406	CARD_NOT_BELONG_DOCUMENT_NUMBER	Card does not belong to this document number!	O cartão não pertence a este número de documento.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.