Consulta de opções de pagamento

stable

Este endpoint permite que o cliente do parceiro Bankly consulte as opções de pagamento de uma fatura de cartão.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

  • A fatura do cliente esteja fechada;
  • A fatura tenha saldo a ser liquidado.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/payment-options 
--request GET \  
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/payment-options' \ 
--header 'Authorization:  Bearer {Token} ' \ 
--header 'accept: application/json'\ 
--header 'api-version: 1' 

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 referentes à 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 o seguinte campo:

NomeTipoDescrição
statementIdpathObrigatório. Identificador único da fatura.

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 e retornará uma lista com as opções de pagamento, os possíveis parcelamentos e suas informações.

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

NomeTipoDescrição
paymentOptionIdintegerIdentificador único da opção de pagamento.
statementIdintegerIdentificador único da fatura.
paymentTypestringOpção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada), “InstallmentWithoutEntry” (parcelado sem entrada)
valuenumberValor a ser pago (no caso de parcelamento, será a entrada).
payment[]array of objectsLista de objetos contendo informações sobre a opção de pagamento.
payment[].paymentIdintegerIdentificador único do pagamento.
payment[].paymentOptionIdintegerIdentificador único da opção de pagamento.
payment[].paymentBilletIdstringCódigo de registro do boleto. Este campo somente será retornado caso a forma de pagamento escolhida tenha sido “Billet”.
payment[].amountnumberValor do pagamento.
payment[].dueDatestringData de vencimento do pagamento, no formato ISO 8601 - UTC.
payment[].paymentOptionTypestringForma de pagamento. No caso de faturas de cartão, esse campo virá preenchido com o valor “Billet” (Boleto).
payment[].statusstringSituação do pagamento, que pode ser “Pending” (pendente) ou “Paid” (pago).
payment[].digitableLinestringLinha digitável do boleto de pagamento. Este campo somente será retornado caso a forma de pagamento escolhida tenha sido “Billet”.
payment[].paymentDatestringData de pagamento, no formato ISO 8601 - UTC.
payment[].liquidatedPaymentDatestringData de liquidação do pagamento, no formato ISO 8601 - UTC.
creditOfferobjectObjeto que contém informações sobre a proposta de parcelamento da fatura.
creditOffer.creditOfferIdintegerIdentificador único da proposta.
creditOffer.externalOperationIdstringIdentificador externo da operação.
creditOffer.externalOfferIdstringIdentificador externo da proposta.
creditOffer.externalOfferTypestringTipo da proposta externa retornada, o qual pode ser “Variable” (referente à proposta de parcelamento) ou “Fixed” (referente à proposta de crédito rotativo).
creditOffer.amountCurrencystringCódigo da moeda de acordo com a ISO-4217 (exemplo: BRL).
creditOffer.amountDuenumberValor contratado da proposta mais o valor total de juros (pode ou não conter TAC).
creditOffer.annualCetnumberCET (custo efetivo total) da contratação calculado ao ano.
creditOffer.annualInterestRatenumberTaxa de juros anual da contratação.
creditOffer.cetnumberCET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas.
creditOffer.disbursementDatestringData prevista para o desembolso da proposta.
creditOffer.externalCreatedAtstringData do cálculo da proposta no formato ISO 8601.
creditOffer.externalExpiresAtstringData de expiração da proposta no formato ISO 8601.
creditOffer.firstPaymentDatestringData do primeiro pagamento da proposta no formato ISO 8601.
creditOffer.graceDaysintegerQuantidade de dias para a carência do primeiro pagamento.
creditOffer.lastPaymentDatestringData do último pagamento da proposta.
creditOffer.loanAmountnumberValor do crédito solicitado para contratação.
creditOffer.monthlyInterestRatenumberTaxa de juros mensal da contratação.
creditOffer.operationCostAmountnumberCusto de processamento da operação.
creditOffer.retentionRatenumberIndica o percentual de retenção da proposta.
creditOffer.termintegerQuantidade de parcelas da proposta.
creditOffer.totalInterestAmountnumberValor total de juros a ser pago na contratação.
creditOffer.totalPaymentAmountnumberValor total a ser pago no final do contrato (se aplicável ao produto).
creditOffer.iofTotalAmountnumberValor final do cálculo do IOF.
creditOffer.iofTotalPercentagenumberValor percentual do IOF, se aplicável.
creditOffer.confirmedOfferbooleanInforma se a oferta está confirmada.
creditOffer.diaryIofnumberValor diário do IOF aplicado.
creditOffer.fixedIofnumberValor fixo do IOF aplicado.
creditOffer.Installments[]array of objectsLista de objetos contendo os parcelamentos e suas informações.
creditOffer.Installments[].creditOfferIdintegerIdentificador único da proposta.
creditOffer.Installments[].amortizationAmountnumberValor da amortização no contrato.
creditOffer.Installments[].dueDatestringData de vencimento da parcela.
creditOffer.Installments[].interestAmountnumberValor dos juros da parcela.
creditOffer.Installments[].iofAmountnumberValor do IOF da parcela.
creditOffer.Installments[].paymentAmountnumberValor da parcela.
creditOffer.Installments[].installmentNumberintegerNúmero da parcela.
[ 
  { 
    "paymentOptionId": 0, 
    "statementId": 0, 
    "paymentType": "Cash", 
    "value": 0, 
    "payment": [ 
      { 
        "paymentId": 0, 
        "paymentOptionId": 0, 
        "paymentBilletId": "string", 
        "amount": 0, 
        "dueDate": "2022-10-25T19:10:08.538Z", 
        "paymentOptionType": "Boleto", 
        "status": "Pending", 
        "digitableLine": "string", 
        "paymentDate": "2022-10-25T19:10:08.538Z", 
        "liquidatedPaymentDate": "2022-10-25T19:10:08.538Z", 
      } 
    ], 
    "creditOffer": { 
      "creditOfferId": 0, 
      "externalOperationId": "string", 
      "externalOfferId": "string", 
      "externalOfferType": "string", 
      "amountCurrency": "string", 
      "amountDue": 0, 
      "annualCet": 0, 
      "annualInterestRate": 0, 
      "cet": 0, 
      "disbursementDate": "2022-10-25T19:10:08.538Z", 
      "externalCreatedAt": "2022-10-25T19:10:08.538Z", 
      "externalExpiresAt": "2022-10-25T19:10:08.538Z", 
      "firstPaymentDate": "2022-10-25T19:10:08.538Z", 
      "graceDays": 0, 
      "lastPaymentDate": "2022-10-25T19:10:08.538Z", 
      "loanAmount": 0, 
      "monthlyInterestRate": 0, 
      "operationCostAmount": 0, 
      "retentionRate": 0, 
      "term": 0, 
      "totalInterestAmount": 0, 
      "totalPaymentAmount": 0, 
      "iofTotalAmount": 0, 
      "iofTotalPercentage": 0, 
      "confirmedOffer": true,
      "diaryIof":0.0082, 
      "fixedIof":0.3800, 
      "installments": [ 
        { 
          "creditOfferId": 0, 
          "amortizationAmount": 0, 
          "dueDate": "2022-10-25T19:10:08.538Z", 
          "interestAmount": 0, 
          "iofAmount": 0, 
          "paymentAmount": 0, 
          "installmentNumber": 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 CodeCódigoMensagemDescrição
406STATEMENT_IS_NOT_CLOSEDStatement is not closed!A fatura não está fechada.

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.