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:
Scope | Descrição |
---|---|
invoice.read | Concede acesso para realizar consultas referentes à 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 o seguinte campo:
Nome | Tipo | Descrição |
---|---|---|
statementId | path | Obrigató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:
Nome | Tipo | Descrição |
---|---|---|
paymentOptionId | integer | Identificador único da opção de pagamento. |
statementId | integer | Identificador único da fatura. |
paymentType | string | Opção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada), “InstallmentWithoutEntry” (parcelado sem entrada) |
value | number | Valor a ser pago (no caso de parcelamento, será a entrada). |
payment[] | array of objects | Lista de objetos contendo informações sobre a opção de pagamento. |
payment[].paymentId | integer | Identificador único do pagamento. |
payment[].paymentOptionId | integer | Identificador único da opção de pagamento. |
payment[].paymentBilletId | string | Código de registro do boleto. Este campo somente será retornado caso a forma de pagamento escolhida tenha sido “Billet”. |
payment[].amount | number | Valor do pagamento. |
payment[].dueDate | string | Data de vencimento do pagamento, no formato ISO 8601 - UTC. |
payment[].paymentOptionType | string | Forma de pagamento. No caso de faturas de cartão, esse campo virá preenchido com o valor “Billet” (Boleto). |
payment[].status | string | Situação do pagamento, que pode ser “Pending” (pendente) ou “Paid” (pago). |
payment[].digitableLine | string | Linha digitável do boleto de pagamento. Este campo somente será retornado caso a forma de pagamento escolhida tenha sido “Billet”. |
payment[].paymentDate | string | Data de pagamento, no formato ISO 8601 - UTC. |
payment[].liquidatedPaymentDate | string | Data de liquidação do pagamento, no formato ISO 8601 - UTC. |
creditOffer | object | Objeto que contém informações sobre a proposta de parcelamento da fatura. |
creditOffer.creditOfferId | integer | Identificador único da proposta. |
creditOffer.externalOperationId | string | Identificador externo da operação. |
creditOffer.externalOfferId | string | Identificador externo da proposta. |
creditOffer.externalOfferType | string | Tipo da proposta externa retornada, o qual pode ser “Variable” (referente à proposta de parcelamento) ou “Fixed” (referente à proposta de crédito rotativo). |
creditOffer.amountCurrency | string | Código da moeda de acordo com a ISO-4217 (exemplo: BRL). |
creditOffer.amountDue | number | Valor contratado da proposta mais o valor total de juros (pode ou não conter TAC). |
creditOffer.annualCet | number | CET (custo efetivo total) da contratação calculado ao ano. |
creditOffer.annualInterestRate | number | Taxa de juros anual da contratação. |
creditOffer.cet | number | CET (custo efetivo total) da contratação calculado na periodicidade definida das parcelas. |
creditOffer.disbursementDate | string | Data prevista para o desembolso da proposta. |
creditOffer.externalCreatedAt | string | Data do cálculo da proposta no formato ISO 8601. |
creditOffer.externalExpiresAt | string | Data de expiração da proposta no formato ISO 8601. |
creditOffer.firstPaymentDate | string | Data do primeiro pagamento da proposta no formato ISO 8601. |
creditOffer.graceDays | integer | Quantidade de dias para a carência do primeiro pagamento. |
creditOffer.lastPaymentDate | string | Data do último pagamento da proposta. |
creditOffer.loanAmount | number | Valor do crédito solicitado para contratação. |
creditOffer.monthlyInterestRate | number | Taxa de juros mensal da contratação. |
creditOffer.operationCostAmount | number | Custo de processamento da operação. |
creditOffer.retentionRate | number | Indica o percentual de retenção da proposta. |
creditOffer.term | integer | Quantidade de parcelas da proposta. |
creditOffer.totalInterestAmount | number | Valor total de juros a ser pago na contratação. |
creditOffer.totalPaymentAmount | number | Valor total a ser pago no final do contrato (se aplicável ao produto). |
creditOffer.iofTotalAmount | number | Valor final do cálculo do IOF. |
creditOffer.iofTotalPercentage | number | Valor percentual do IOF, se aplicável. |
creditOffer.confirmedOffer | boolean | Informa se a oferta está confirmada. |
creditOffer.diaryIof | number | Valor diário do IOF aplicado. |
creditOffer.fixedIof | number | Valor fixo do IOF aplicado. |
creditOffer.Installments[] | array of objects | Lista de objetos contendo os parcelamentos e suas informações. |
creditOffer.Installments[].creditOfferId | integer | Identificador único da proposta. |
creditOffer.Installments[].amortizationAmount | number | Valor da amortização no contrato. |
creditOffer.Installments[].dueDate | string | Data de vencimento da parcela. |
creditOffer.Installments[].interestAmount | number | Valor dos juros da parcela. |
creditOffer.Installments[].iofAmount | number | Valor do IOF da parcela. |
creditOffer.Installments[].paymentAmount | number | Valor da parcela. |
creditOffer.Installments[].installmentNumber | integer | Nú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 Code | Código | Mensagem | Descrição |
---|---|---|---|
406 | STATEMENT_IS_NOT_CLOSED | Statement 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.
Updated 1 day ago