---
title: "Consultar um pedido de liquidação cadastrado"
method: GET
path: "/v1/scf/settlements/{settlementId}"
tags: ["Settlement"]
---

# Consultar um pedido de liquidação cadastrado

`GET /v1/scf/settlements/{settlementId}`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/v1/scf/settlements/{settlementId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/scf/settlements`, `empresas.btgpactual.com/scf/settlements.readonly`

O objetivo dessa rota é pesquisar um pedido de liquidação previamente cadastrado.

## Path parameters

- `settlementId` string, required: Identificador

## Response `200`

Sucesso na consulta do pedido de liquidação.

- SettlementReadSchema
  - `id` string: Identificador da liquidação
  - `payment` object
    - `account` AccountSchema: Dados da conta bancária
      - `bank` string: Código do banco
      - `agency` string: Agência da conta bancária
      - `number` string: Número da conta bancária
      - `digit` string: Dígito da conta bancária
    - `method` 'pix' | 'ted'
    - `code` string: Identificador a ser preenchido na transferência via PIX ou TED.
    - `maturityDate` string: Timestamp (ISO 8601) da data e hora limite para expiração do pagamento. O pagamento deve ser realizado até essa hora, caso contrário, a liquidação será cancelada.
    - `amount` number: Valor de pagamento da transação
  - `contracts` object[]
    - `contractId` string: Identificador do contrato
    - `installments` number[]
    - `status` 'PROCESSING' | 'PROCESSED' | 'CANCELLED' | 'INVALID': Status do trade
    - `reason` string: Descrição do status
  - `status` 'CREATED' | 'VALIDATING' | 'INVALID' | 'WAITING_FOR_PAYMENT' | 'PROCESSED' | 'EXPIRED': Status da liquidação

## Other responses

- `400`: Erro de validação
- `401`: Não autorizado
- `default`: Erro

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
