---
title: "Consulta de pagamento por conta"
method: GET
path: "/bill-payment"
tags: ["Consultas"]
---

# Consulta de pagamento por conta

`GET /bill-payment`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/bill-payment`
- Auth: none declared. Required headers: `api-version`, `Authorization`, `x-correlation-id`

<div class="bkly-ref-description">
  <p>Consulte todos os pagamentos (completados ou não) realizados por uma conta específica.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> 
  <span class="bkly-ref-scope-tag">scope: payment.read</span>
</div> 
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Consulta de pagamento por conta](/docs/consulta-pagamento-por-conta)."
}
[/block]

## Query parameters

- `bankBranch` string, required: Número da agência do banco do pagador.
- `bankAccount` string, required: Número da conta do pagador.
- `pageSize` integer: Número de itens por página que a consulta deve retornar.
- `pageToken` string: Após a primeira consulta, será retornado um token no campo nextPage, que identifica as páginas retornadas. Caso deseje consultar a próxima página, é preciso informá-lo neste campo (<code>pageToken</code>).

## Headers

- `api-version` string, required
- `Authorization` string, required: <i>Token</i> de autorização do tipo Bearer.
- `x-correlation-id` string, required: Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

## Response `200`

Recurso encontrado.

- QueryAccountResponse
  - `nextPage` string, nullable: Identificador da página retornada. Caso deseje consultar a próxima página, é preciso informá-lo no campo <code>pageToken</code>.
  - `authenticationCode` string, uuid: Id de confirmação da transação que poderá ser utilizado para consultar um pagamento específico.
  - `bankBranch` string, nullable: Número da agência do banco do pagador.
  - `bankAccount` string, nullable: Número da conta do pagador.
  - `paymentDate` string, date-time: Data do pagamento.
  - `status` 'Created' | 'Completed' | 'Canceled': Situação do pagamento.
  - `companyKey` string, nullable: Chave identificadora da companhia.
  - `documentNumber` string, nullable: Número do documento do pagador.
  - `confirmedAt` string, date-time: Data da confirmação do pagamento.
  - `digitable` string, nullable: Linha digitável.
  - `amount` number, double: Valor pago.
  - `originalAmount` number, double: Valor original, sem encargos.
  - `assignor` string, nullable: Nome do cedente.
  - `recipientDocument` string, nullable: Número do documento do recebedor.
  - `recipientName` string, nullable: Nome do recebedor do pagamento.
  - `charges` BillCharges: Objeto que contém informações sobre os encargos aplicados na transação. Em caso de pagamentos desfeitos, esse objeto retornará seus campos com valores <b>nulos</b>.
    - `interestAmountCalculated` number, double: Valor dos juros.
    - `fineAmountCalculated` number, double: Valor da multa.
    - `discountAmount` number, double: Valor do desconto.
  - `settleDate` string, date-time: Data de liquidação do título.
  - `dueDate` string, date-time: Data de vencimento do título.
  - `descritpion` string, nullable: Descrição do pagamento.

## Other responses

- `400`: Há algum problema com a sua requisição.
- `403`: O acesso ao recurso foi negado pelo servidor.

---

[API](https://skmtc.dev/bankly/apis/pagamento-de-contas.md) - [All operations](https://skmtc.dev/bankly/apis/pagamento-de-contas/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/pagamento-de-contas/revisions/880c2bac4ff1?raw)