API
Status PageSuporte

Consulta de boletos com paginação

get
https://sandbox.openfinance.celcoin.dev/billissuance/v1/bill

Esta API permite que o cliente consulte um boleto emitido anteriormente, podendo verificar seu status e as demais informações geradas no momento da emissão.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Valores SortType Tipo de ordenação.

Values:

  • ASC - Crescente.
  • DESC - Decrescente.

Allowed:
int32
1 to 2147483647

Propriedade Page Página atual.

int32
1 to 2147483647

Propriedade Limit Limite de consulta de dados.

int32
1 to 999

Propriedade WalletCode Código da carteira.

string

Propriedade Document CPF ou CNPJ do beneficiário original.

string
enum

Valores PaymentType Tipo de Pagamento do boleto.

Values:

  • TOTAL - Aceita apenas um único pagamento no valor total do boleto, incluindo juros, multas e descontos.
  • DIVERGENTE - Aceita apenas um único pagamento no valor definido entre o intervalo dos campos maxValue e minValue.
  • PARCIAL - Aceite a quantidade de pagamentos estipulada no campo partials no valor definido entre o intervalo dos campos maxValue e minValue.

Allowed:
string
enum

Valores BillStatus Situação do boleto.

Values:

  • PROCESSAMENTO - Processamento.
  • REJEITADO - Rejeitado.
  • REGISTRADO - Registrado.
  • BAIXADO - Baixado.
  • LIQUIDADO_PARCIAL - Liquidado parcial.
  • LIQUIDADO_INTEGRAL - Liquidado integral.
  • CANCELADO - Cancelado.
  • EXPIRADO - Expirado.

string

Propriedade DueDate Data de vencimento do boleto.

string

Propriedade IssueDate Data de emissão do boleto.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 months ago

Language
Credentials
http
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 6 months ago