---
title: "Consultar carteira de algum contrato ou contraparte especifica"
method: GET
path: "/contract-wallet"
tags: ["Wallet"]
---

# Consultar carteira de algum contrato ou contraparte especifica

`GET /contract-wallet`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/contract-wallet`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://id.btgpactual.com/oauth2/token` scopes: `empresas.btgpactual.com/wallet.readonly`

O objetivo dessa rota é pesquisar a carteira de algum contrato ou contraparte especifica.

## Query parameters

- `taxId` string: CNPJ/CPF
- `identification` string: Identificador do contrato

## Response `200`

Sucesso

- ContractSchema[]
  - `externalId` string: Identificador externo da operação
  - `contractNumber` string: Identificador do contrato da operação
  - `fund` string: Identificador do fundo relacionado a operação
  - `lastBalanceDate` string, date: Data da ultima posição processada
  - `tradeId` string: Identificador da operação
  - `loanValue` number, double: Valor da operação
  - `dueValue` number, double: Valor da posição da operação
  - `paidValue` number, double: Valor pago na operação
  - `rate` number, double: Taxa da operação
  - `cet` number, double: Custo efetivo total da operação
  - `paymentIsDue` boolean: Boleano identificando se o cliente está inadimplente
  - `type` string: Tipo da operação
  - `status` string: Status da operação. Possíveis: 0 - SETTLED (Pago), 1 - COMPLIANT (Adimplente), 2 - OVERDUE (Inadimplente), 3 - RENEGOTIATED (Renegociado), 4 - NORMAL (Adimplente)
  - `startDate` string, date: Data de inicio da operação
  - `maturityDate` string, date: Data de vencimento da operação
  - `activeContract` string: Identificador do contrato ativo
  - `linkedTrades` string[]
  - `contracts` string[]
  - `charges` object[]
    - `installmentNumber` number: Numero da parcela
    - `paid` boolean: Boleano identificando se a parcela foi paga
    - `dueDate` string, date: Data de vencimento da parcela
    - `value` number, double: Valor da parcela
    - `paidValue` number, double: Valor pago na parcela
    - `paidDate` string, date: Data de pagamento da parcela
    - `bankSlipId` string: Identificador unico do boleto
    - `status` string: Status da parcela. Possíveis: 0 - PAID (pago), 1 - OPEN (em aberto), 2 - OVERDUE (inadimplente), 3 - RENEGOTIATED (renegociado).
    - `interestArrearsValue` number, double: Mora da parcela
    - `latePaymentValue` number, double: Juros sobre atraso
    - `penaltyFeeValue` number, double: Multa da parcela
    - `principalValue` number, double: Valor do principal da parcela
    - `paymentHistory` object[]
      - `status` string: Status do pagamento realizado. Possiveis: Confirming, Confirmed, Cancelling, Cancelled, WaitingRelease, ConfirmedPreImpact, ConfirmingPreImpact, WaitingApproval, Error, ScheduledPayment, SentToProcess
      - `latePaymentValue` number, double: Juros sobre atraso do pagamento
      - `penaltyFeeValue` number, double: Multa da parcela do pagamento
      - `interestArrearsValue` number, double: Mora da parcela do pagamento
      - `paidValue` number, double: Valor total pago do pagamento
      - `paidDate` string, date: Data de pagamento
      - `principalValue` number, double: Valor pago do principal
      - `discontValue` number, double: Valor de disconto aplicado no pagamento
      - `fixedInterestValue` number, double: Juros Pre do pagamento
      - `floatInterestValue` number, double: Juros Pos do pagamento
      - `paymentTotal` boolean: Indicador do pagamento ser total
      - `iOFValue` number, double: IOF do pagamento

## Other responses

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