---
title: "Listar Pagamentos de Boleto"
method: GET
path: "/v1/bank_billet_payments"
tags: ["Recebimento de Boleto"]
---

# Listar Pagamentos de Boleto

`GET /v1/bank_billet_payments`

## Request

- Base URL: `https://api-sandbox.kobana.com.br`
- URL: `https://api-sandbox.kobana.com.br/v1/bank_billet_payments`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kobana/apis/cobran-as/docs/v1/bank_billet_payments/get.ts> (a function with typed inputs; its response is checked against the schema)

Listar Pagamentos de Boleto.

## Query parameters

- `page` integer
- `per_page` integer
- `paid_from` string, date
- `paid_to` string, date
- `bank_billet_id` string
- `bank_billet_account_id` string

## Headers

- `User-Agent` string

## Response `200`

Sucesso na listagem dos pagamentos de boletos

- BankBilletPaymentObject[]
  - `id` integer: ID do Recebimento de Boleto
  - `bank_billet_id` integer, nullable, required: ID do Boleto.
  - `bank_billet_account_id` integer, nullable, required: ID da Carteira.
  - `discharge_id` integer, nullable: ID do Retorno.
  - `amount` number, float: Valor do Boleto
  - `paid_amount` number, float, required: Valor Pago
  - `paid_at` string, date, nullable, required: Data do Recebimento.
  - `paid_bank` string, nullable: Banco de Recebimento.
  - `paid_agency` string, nullable: Agência de Recebimento (com dígito quando disponível).
  - `paid_agency_number` string, nullable: Número da Agência de Recebimento (sem dígito).
  - `paid_agency_digit` string, nullable: Dígito da Agência de Recebimento.
  - `bank_rate` number, float, nullable: Taxa bancária
  - `credit_at` string, date, nullable: Data de crédito.
  - `direct` boolean, nullable: Recebimento direto ao beneficíario
  - `expire_at` string, date, nullable: Data de vencimento.
  - `kind` 0 | 1 | 2, required: Tipo de Recebimento: * `0` Direto ao beneficíario/Em mãos * `1` Boleto (Confirmado pelo banco via arquivo de retorno ou API) * `2` Pix (Confirmado pelo banco via Pix)
  - `document_number` string, nullable: Número do Documento.
  - `our_number` string, nullable: Nosso Número.
  - `created_via_api` boolean, nullable: Enviado pela API
  - `created_at` string, date-time, nullable: Data e hora de criação.
  - `updated_at` string, date-time, nullable: Data e hora da última atualização.
  - `customer_person_name` string, nullable: Nome do cliente
  - `paid_by_pix` boolean, nullable: Recebimento via Pix
  - `financial_provider_external_id` string, nullable: ID do recebimento na instituição financeira
  - `line_parsed` string, json, nullable: Linha parseada com informações vindas do banco: Conteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação. | Valor | Descrição | |---|---| | paid_at | Data de recebimento | | paid_amount | Valor pago | | bank_rate | Taxa do boleto paga ao banco | | credit_at | Data de crédito | | credit_amount | Valor do Crédito | | our_number | Nosso número | | processed_our_number_raw | Nosso número formatado | | discount | Desconto | | billet_fine | Acréscimos(Multa/Juros cobrados) | | other_fines | Outras cobranças adicionais | | other_credit | Outros valores pagos | | value_rebate | Outras taxas | | error_code | Código de erro | | event_type | Ocorrência bancária | | agency_number | Agência | | account_number | Conta | | banco_recebedor | Banco recebedor | | agencia_recebedora | Agência recebedora | | control_number | Número de Controle | | document_number | Número do Documento |

## Other responses

- `401`: Falha de autenticação. Token inválido
- `403`: Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

---

[API](https://skmtc.dev/kobana/apis/cobran-as.md) - [All operations](https://skmtc.dev/kobana/apis/cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/kobana/apis/cobran-as/revisions/728c362ec4d7?raw)