---
title: "Consultar um pedido de pagamento cadastrado"
method: GET
path: "/settlement/{settlementId}"
tags: ["Payment"]
---

# Consultar um pedido de pagamento cadastrado

`GET /settlement/{settlementId}`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/settlement/{settlementId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/loans`

O objetivo dessa rota é pesquisar um pedido de pagamento previamente cadastrado.

## Path parameters

- `settlementId` string, required: Identificador

## Query parameters

- `agreementId` string, required: Identificador do convênio

## Response `200`

Resultado da consulta de 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

- `401`: Não autorizado
- `404`: Não encontrado
- `500`: 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)
