Consulta de fatura por período

stable

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:

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:

ScopeDescrição
invoice.readConcede acesso para realizar consultas referente à gestão de faturas.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescriçãoEspecificação
documentNumberpathObrigatório. Número do documento do titular do cartão (CPF ou CNPJ).Informe apenas números, sem caracteres especiais.
proxypathObrigatório. Código identificador do cartão.
initialDatequeryObrigatório. Data inicial, referente ao vencimento da fatura, para a consulta.Formato YYYY-MM-DD.
finalDatequeryObrigató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:

NomeTipoDescrição
statements[]array of objectsLista de objetos contendo informações sobre todas as faturas de um determinado período.
statements[].statementIdintegerIdentificador único da fatura.
statements[].monthintegerMês de vencimento da fatura.
statements[].yearintegerAno de vencimento da fatura.
statements[].cycleintegerIndicador do ciclo da fatura (por contrato de crédito).
statements[].dueDatestringData de vencimento da fatura, no formato ISO 8601 - UTC.
statements[].amountMinimalnumberValor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura.
statements[].balancenumberValor total da fatura.
statements[].cycleTypestringSituação da fatura, que pode ser “Open” (fatura aberta), “Future” (fatura futura), “Closed” (fatura fechada) e “DueDate” (fatura atrasada).
statements[].paymentStatusstringSituação do pagamento da fatura, que pode ser “Pending” (pendente), “Paid” (paga) e “PartialPaid” (parcialmente paga).
statements[].paymentTotalAmountnumberValor 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 não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.


Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados