ReadMe_CollateralizedCreditReceivablesResponse

Recebíveis de um contrato de crédito com garantia

creditIdstring<uuid>

Identificador do contrato

Exemplo 11111111-1111-4111-8111-111111111111

receivables object[]

Lista de recebíveis

Lista [

receivableIdstring

Identificador do recebível

Exemplo 10

acquirerTaxIdstring

CNPJ do adquirente

Exemplo 01027058000191

paymentSchemestring

Código do arranjo de pagamento

Exemplo MCC

settlementDatestring<date>

Data de liquidação

Exemplo 2025-08-15

requestedAmountnumber<double>

Valor solicitado para o recebível dentro do contrato

Exemplo 1500

effectivelyEncumberedAmountnumber<double>aceita valor nulo

Valor efetivamente onerado no recebível após confirmação do registrador. Vem nulo até a confirmação ser recebida.

Exemplo 1450

]

pagination object

Metadados de paginação baseada em cursor

currentItemstring

ID do item atual (primeiro da página)

Exemplo 10

limitinteger<int32>

Número de itens por página

Exemplo 30

nextItemstringaceita valor nulo

ID do proximo item (para paginação)

Exemplo 9

totalItemsinteger<int64>

Total de itens disponíveis

Exemplo 150

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

ReadMe_CollateralizedCreditReceivablesResponse

{
  "creditId": "11111111-1111-4111-8111-111111111111",
  "receivables": [
    {
      "receivableId": "10",
      "acquirerTaxId": "01027058000191",
      "paymentScheme": "MCC",
      "settlementDate": "2025-08-15",
      "requestedAmount": 1500,
      "effectivelyEncumberedAmount": 1450
    }
  ],
  "pagination": {
    "currentItem": "10",
    "limit": 30,
    "nextItem": "9",
    "totalItems": 150
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}