v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Wallet

Consultar carteira de algum contrato ou contraparte especifica

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

get/contract-wallet

Query parameters

taxIdstring

CNPJ/CPF

Example:15996430000182

Identificação da contraparte

identificationstring

Identificador do contrato

Example:6764459321/EP

Identificação do contrato

Response

Sucesso

externalIdstring

Identificador externo da operação

contractNumberstring

Identificador do contrato da operação

fundstring

Identificador do fundo relacionado a operação

lastBalanceDatestring date

Data da ultima posição processada

tradeIdstring

Identificador da operação

loanValuenumber double

Valor da operação

dueValuenumber double

Valor da posição da operação

paidValuenumber double

Valor pago na operação

ratenumber double

Taxa da operação

cetnumber double

Custo efetivo total da operação

paymentIsDueboolean

Boleano identificando se o cliente está inadimplente

typestring

Tipo da operação

statusstring

Status da operação. Possíveis: 0 - SETTLED (Pago), 1 - COMPLIANT (Adimplente), 2 - OVERDUE (Inadimplente), 3 - RENEGOTIATED (Renegociado), 4 - NORMAL (Adimplente)

startDatestring date

Data de inicio da operação

maturityDatestring date

Data de vencimento da operação

activeContractstring

Identificador do contrato ativo

linkedTradesstring[]

contractsstring[]

Example response

[
  {
    "externalId": "b2eaa18b-985e-473f-92bf-8cf9a407aee1",
    "contractNumber": "1247244/HYD",
    "tradeId": "712124",
    "type": "CCB",
    "status": "COMPLIANT",
    "activeContract": "CONTRATO_ATIVO",
    "linkedTrades": [
      "111110"
    ],
    "contracts": [
      "CONTRATO_X"
    ],
    "charges": [
      {
        "bankSlipId": "ea95965a-f45a-4c35-b624-e91788a50ce7",
        "status": "OPEN",
        "paymentHistory": [
          {
            "status": "Confirmed"
          }
        ]
      }
    ]
  }
]