---
title: "Consultar os dados de uma conta"
method: POST
path: "/v5/transactions/billpayments/authorize"
---

# Consultar os dados de uma conta

`POST /v5/transactions/billpayments/authorize`

Essa API permite a consulta de uma conta (boleto) para validação dos seus dados. Veja o nosso [artigo](https://developers.celcoin.com.br/docs/pagamento-de-contas-1#consultar-os-dados-de-uma-conta-authorize) e saiba como realizar a implementação dessa API. 

Entenda quais são os erros que essa API poderá retornar ao realizar a consulta de um pagamento, [clique aqui](https://developers.celcoin.com.br/docs/tabelas-de-erros#tabela-de-consulta-de-um-pagamento-atrav%C3%A9s-do-c%C3%B3digo-de-barras-ou-linha-digit%C3%A1vel).

Para testes em ambiente de sandbox recomendamos que seja utilizado a nossa [massa de testes](https://developers.celcoin.com.br/page/tabela-de-massa-de-teste-para-pagamentos-de-ficha-de-compensa%C3%A7%C3%A3o).

## Request body

- object
  - `externalTerminal` string — Identificador do terminal do sistema cliente
  - `externalNSU` integer — Identificador da transação do sistema cliente
  - `barCode` object, required
    - `type` integer, required — Tipo da conta a ser consultada, onde ficha de compensação deve ser populado com o número 2 e concessionária 1
    - `digitable` string — Linha digitável
    - `barCode` string — Código de barras

## Response `200`

200

- object
  - `assignor` string
  - `registerData` object
    - `documentRecipient` string
    - `documentPayer` string
    - `payDueDate` string
    - `nextBusinessDay` unknown
    - `dueDateRegister` string
    - `allowChangeValue` boolean
    - `recipient` string
    - `payer` string
    - `discountValue` integer
    - `interestValueCalculated` integer
    - `maxValue` integer
    - `minValue` number
    - `fineValueCalculated` integer
    - `originalValue` number
    - `totalUpdated` number
    - `totalWithDiscount` integer
    - `totalWithAdditional` integer
    - `totalPaymentPaid` integer
    - `totalValuePaid` number
    - `maxPartialsAccepts` integer
    - `paymentSpecies` integer
    - `documentRecipientFinal` string
    - `recipientFinal` string
  - `settleDate` string
  - `dueDate` string
  - `endHour` string
  - `initeHour` string
  - `nextSettle` string
  - `digitable` string
  - `transactionId` integer
  - `type` integer
  - `value` number
  - `maxValue` unknown
  - `minValue` unknown
  - `errorCode` string
  - `message` unknown
  - `status` integer

## Other responses

- `400` — 400
- `401` — 401
- `500` — 500

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)