---
title: "Consulta por código de autenticação"
method: GET
path: "/bill-payment/detail"
tags: ["Consultas"]
---

# Consulta por código de autenticação

`GET /bill-payment/detail`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/bill-payment/detail`
- Auth: none declared

<div class="bkly-ref-description">
  <p>Consulte todos os detalhes de um pagamento específico (completado ou não) por meio de seu código de autenticação (<code>authenticationCode</code>).</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 por código de autenticação](/docs/consulta-por-codigo-de-autenticacao)."
}
[/block]

## Query parameters

- `bankBranch` string, required: Número da agência do banco do pagador.
- `bankAccount` string, required: Número da conta do pagador.
- `authenticationCode` string, required: Código de autenticação do pagamento que se deseja consultar. O valor pode ser obtido no retorno da requisição de confirmação de pagamento.

## Parameters

- `#/paths/~1bill-payment/get/parameters/0` (unresolved $ref)
- `#/paths/~1bill-payment/get/parameters/1` (unresolved $ref)
- `#/paths/~1bill-payment/get/parameters/2` (unresolved $ref)

## Response `200`

Recurso encontrado.

- QueryAutenticationCodeResponse
  - `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` (unresolved $ref)
- `403` (unresolved $ref)

---

[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)