BAbankly
Consulta de faturas

Consulta de fatura aberta

<div class="bkly-ref-description"> <p>Consulte os dados de uma fatura em aberto (<code>cycleType</code> = “Open”) por meio do <i>proxy</i> do cartão e do número do documento de seu titular.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: invoice.read</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Consulta de fatura aberta](/docs/consulta-de-fatura-aberta)." } [/block]
get/cards/invoices/document/{documentNumber}/proxy/{proxy}/open

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}/open
  • Auth
    HTTP bearer

Path parameters

documentNumberstring nullable required

Número do documento do titular do cartão.

proxystring nullable required

Código identificador do cartão utilizado na transação.

Parameters

#/paths/~1cards~1invoices~1adjustments/post/parameters/1 (unresolved $ref)
#/paths/~1cards~1invoices~1adjustments/post/parameters/0 (unresolved $ref)

Response

Solicitação aceita com sucesso.

statementIdinteger

Identificador único da fatura.

monthinteger

Mês de vencimento da fatura.

yearinteger

Ano de vencimento da fatura.

cycleinteger

Indicador do ciclo da fatura (por contrato de crédito).

cycleCloseDatestring date-time nullable

Data de fechamento da fatura.

dueDateStartstring date-time

Data inicial do período da fatura.

dueDateEndstring date-time nullable

Data final do período da fatura.

dueDatestring date-time

Data de vencimento da fatura.

amountMinimalnumber double nullable

Valor mínimo a ser pago da fatura. Somente é calculado após o fechamento da fatura.

balancenumber double nullable

Valor total da fatura.

cycleType'Open' | 'Future' | 'Closed' | 'DueDate'

Situação da fatura.

documentNumberstring nullable

Número do documento do titular do cartão (CPF ou CNPJ).

paymentStatus'Pending' | 'Paid' | 'PartialPaid'

Situação do pagamento da fatura.

elegibilityCompulsoryboolean

Sinaliza se a fatura é elegível (true) ou não (false) ao parcelamento compulsório.

Changes

No recorded changes to this operation across all 1 revision of this API.