Retornando lista de boleto emitidos

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

document

string

opcional

Filtro pelo documento do boleto emitido

Exemplo:

0123456789

amount_start

string

opcional

Filtro em centavos do valor do boleto. Valor min.

Exemplo:

100

amount_end

string

opcional

Filtro em centavos do valor do boleto. Valor max.

Exemplo:

10000

name

string

opcional

Filtro pelo nome à quem foi emitido o boleto

Exemplo:

STRING

due_date_start

string

opcional

Faixa inicial de data de vencimento

Exemplo:

yyyy-mm-dd

due_date_end

string

opcional

Faixa final de data de vencimento

Exemplo:

yyyy-mm-dd

start_date

string

opcional

Faixa inicial de data de emissão

Exemplo:

yyyy-mm-dd

end_date

string

opcional

Faixa final de data de emissão

Exemplo:

yyyy-mm-dd

status

string

opcional

Status do boleto: opened | paid | canceled

Exemplo:

opened

startPaymentDate

string

opcional

Exemplo:

yyyy-mm-dd

endPaymentDate

string

opcional

Exemplo:

yyyy-mm-dd

Parâmetros Header

Content-Type

string

requerido

Exemplo:

application/json

Session-id

string

requerido

Exemplo:

teste

branch-id

string

requerido

Exemplo:

Parâmetros Bodyapplication/json

object {0}

Exemplo

{}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.valut.app/openbank/v1/boleto' \
--header 'Session-id: teste' \
--header 'branch-id: {{branchId}}' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Respostas

🟢200Retornando lista de boleto emitidos

application/json

Body

array of:

url

string

opcional

payment_at

null

opcional

amount_paid

integer

opcional

bar_code

string

opcional

cancelation_at

string

opcional

channel

string

opcional

code

string

opcional

digitable_line

string

opcional

payment_notification_at

null

opcional

your_number

string

opcional

account_name

string

opcional

document

string

opcional

id

string

opcional

amount

integer

opcional

expiration

string

opcional

status

string

opcional

share_description

string

opcional

Exemplo

[
    {
        "url": "https://api.brasilcash.com.br/cdn/v1/boleto/498329d7-0588-eb11-9889-0003ff3c8511/print",
        "payment_at": null,
        "amount_paid": 0,
        "bar_code": "21891856400000060000010004261100803626902338",
        "cancelation_at": "2021-05-21T14:30:00.393",
        "channel": "Teste via Brasil Cash",
        "code": "p0n11g",
        "digitable_line": "21890010070426110080636269023382185640000006000",
        "payment_notification_at": null,
        "your_number": "84095031042005",
        "account_name": "Teste",
        "document": "01234567890",
        "id": "498329d7-0588-eb11-9889-0003ff3c8590",
        "amount": 6000,
        "expiration": "2021-03-19T00:00:00",
        "status": "Cancelado",
        "share_description": "Para abastecer sua conta, você deve pagar seu boleto com o código. 21890010070426110080636269023382185640000006000, ou se preferir compartilhe o link. https://api.brasilcash.com.br/cdn/v1/boleto/498329d7-0588-eb11-9889-0003ff3c859t/print"
    }
]