Listar Boletos
GET https://sandbox-api.openbank.stone.com.br/api/v1/barcode_payment_invoices
QUERY PARAMS
account_id* string
Identificador da conta.
before string
Cursor opaco da paginação.
after string
Cursor opaco da paginação.
limit integer
Limite de itens retornados.
invoice_type string
Valores permitidos: deposit, proposal ou bill_of_exchange.
status string
Valores Permitidos: CREATED, SETTLED, REGISTERED, CANCELLED, EXPIRED, PENDING.
amount integer
Valor do boleto bancário gerado, em centavos de reais.
issuance_date string
Data da emissão de boleto bancário. Formato “YYYY-MM-DD”.
expiration_date string
Data de vencimento do boleto bancário. Mesmo depois dessa data expirar o pagamento ainda pode ser feito.
Formato “YYYY-MM-DD”.
settled_date string
Data de liquidação do boleto.
amount_lt integer
Valor menor que
amount_gt integer
Valor maior que
start_limit_date string
Listar boletos com data limite a partir dessa data
end_limit_date string
Listar boletos com data limite até essa data
start_expiration_date string
Listar boletos com data de vencimento a partir dessa data
end_expiration_date string
Listar boletos com data de vencimento até essa data
start_issuance_date string
Listar boletos com data de emissão a partir dessa data
end_issuance_date string
Listar boletos com data de emissão até essa data
start_settled_date string
Listar boletos com data de liquidação a partir dessa data
end_settled_date string
Listar boletos com data de liquidação até essa data
barcodestring
Código de barras.
writable_linestring
Código de barras traduzidos em números.
Response
200 OK
content-type: application/json
Body
{
"cursor": {
"after": null,
"before": null,
"limit": 25
},
"data": [
{
"account_id":"8cbeb3d2-750f-4b14-81a1-143ad715c273",
"amount":2000,
"barcode":"19795819100000020000000020200310150334476155",
"beneficiary":{
"account_code":"498910",
"branch_code":"1",
"document":"98146856000174",
"document_type":"cnpj",
"legal_name":"Sr. Mirella",
"trade_name":null
},
"created_at":"2020-03-10T15:03:34Z",
"created_by":"user:380f9969-8946-4f88-a781-be8b7efc1f90",
"customer": {
"document": "11121740755",
"document_type": "cpf",
"legal_name": "Pereira da Silva",
"trade_name": null
},
"discounts": [
{
"date": "2020-11-20",
"value": "0.1"
}
],
"expiration_date":"2020-03-11",
"fee":0,
"fine": {
"date": "2021-01-02",
"value": "1"
},
"id":"2788e49f-6f53-4296-bba4-3eb5101ff3e8",
"interest": {
"date": "2021-01-02",
"value": "1"
},
"invoice_type":"proposal",
"issuance_date":"2020-03-10",
"limit_date":"2020-03-11",
"our_number": "20200427112605941833",
"customer":{
"document":"98146856000174",
"document_type":"cnpj",
"legal_name":"Sr. Mirella",
"trade_name":null
},
"receiver": null,
"registered_at":"2020-03-10T15:03:34Z",
"settled_at":null,
"status":"REGISTERED",
"writable_line":"19790000052020031015703344761550581910000002000"
},
{
"account_id":"8cbeb3d2-750f-4b14-81a1-143ad715c273",
"amount":2000,
"barcode":"19795819100000020000000020200310150334476155",
"beneficiary":{
"account_code":"498910",
"branch_code":"1",
"document":"98146856000174",
"document_type":"cnpj",
"legal_name":"Sr. Mirella",
"trade_name":null
},
"created_at":"2020-03-10T15:03:34Z",
"created_by":"user:380f9969-8946-4f88-a781-be8b7efc1f90",
"customer": {
"document": "11121740755",
"document_type": "cpf",
"legal_name": "Pereira da Silva",
"trade_name": null
},
"discounts": [
{
"date": "2020-11-20",
"value": "0.1"
}
],
"expiration_date":"2020-03-11",
"fee":0,
"fine": {
"date": "2021-01-02",
"value": "1"
},
"id":"2788e49f-6f53-4296-bba4-3eb5101ff3e8",
"interest": {
"date": "2021-01-02",
"value": "1"
},
"invoice_type":"proposal",
"issuance_date":"2020-03-10",
"limit_date":"2020-03-11",
"our_number": "20200427112605941833",
"customer":{
"document":"98146856000174",
"document_type":"cnpj",
"legal_name":"Sr. Mirella",
"trade_name":null
},
"receiver": null,
"registered_at":"2020-03-10T15:03:34Z",
"settled_at":null,
"status":"REGISTERED",
"writable_line":"19790000052020031015703344761550581910000002000",
"payment_invoice": {
"description": "Descrição do pagamento."
},
"metadata": {}
}
]
}
403 Forbidden
Body
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"srn:error:unauthorized"
]
}
}
}