---
title: "Consultar os dados de um boleto antes do pagamento"
method: POST
path: "/v1/marketplace/payments/check-billet"
tags: ["Pagamentos de boletos"]
---

# Consultar os dados de um boleto antes do pagamento

`POST /v1/marketplace/payments/check-billet`

## Request

- Base URL: `https://api.sandbox.paytime.com.br`
- URL: `https://api.sandbox.paytime.com.br/v1/marketplace/payments/check-billet`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/paytime/apis/api-p-blica/docs/v1/marketplace/payments/check-billet/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `integration-key` string, required
- `x-token` string, required

## Request body

- CheckBilletDto
  - `digitable` string: Linha digitável do boleto.
  - `barcode` string: Código de barras do boleto.

## Response `200`

- CheckBilletResponse
  - `barcode` string, required: Código de barras do boleto.
  - `digitable_line` string, required: Linha digitável do boleto.
  - `expected_on` string, date-time, required: Data de vencimento do boleto.
  - `type` number, required: Tipo do boleto.
  - `amount` number, required: Valor a ser pago.
  - `nominal_amount` number, required: Valor nominal do boleto.
  - `discount` number, required: Valor de desconto aplicado ao boleto.
  - `fine` number, required: Valor de multa aplicado ao boleto.
  - `interest` number, required: Valor de juros aplicado ao boleto.
  - `max_amount` number, nullable, required: Valor máximo permitido para pagamento do boleto.
  - `min_amount` number, nullable, required: Valor mínimo permitido para pagamento do boleto.
  - `transaction_id` string, required: Identificador da transação.
  - `recipient` CheckBilletRecipientResponse, required
    - `name` string, required: Nome do beneficiário do boleto.
    - `document` string, required: Documento do beneficiário do boleto.
  - `payer` CheckBilletPayerResponse, required
    - `document` string, required: Documento do pagador do boleto.
    - `name` string, required: Nome do pagador do boleto.
  - `billet_details` CheckBilletDetailsResponse, required
    - `installments_paid` number, required: Quantidade de parcelas já pagas do boleto.
    - `total_amount_paid` number, required: Valor total já pago do boleto.
    - `document_final_recipient` string, nullable, required: Documento do destinatário final do boleto.
    - `final_recipient` string, nullable, required: Nome do destinatário final do boleto.
    - `billet_type` string, required: Tipo do boleto.

---

[API](https://skmtc.dev/paytime/apis/api-p-blica.md) - [All operations](https://skmtc.dev/paytime/apis/api-p-blica/llms.txt) - [OpenAPI document](https://skmtc.dev/paytime/apis/api-p-blica/revisions/5c818991d183?raw)