ReadMe_CollectionDetailResponse

Detalhes de um contrato de cobrança

collectionIdstring<uuid>

Identificador do contrato

Exemplo 22222222-2222-4222-8222-222222222222

externalContractIdstring

Identificador externo do contrato

Exemplo ext-col-001

externalIdstring

Identificador externo individual da operação de cobrança

Exemplo ext-op-001

statusstring

Status do contrato

Valores possíveis: [CREATED, CREATION_PENDING, CREATION_FAILED, CREATION_FAILED_NO_RELATIONS, DELETION_PENDING, DELETION_FAILED, DELETED]

Exemplo CREATED

company object

Dados da empresa vinculada ao contrato

companyTaxIdstring

CNPJ/CPF da empresa

Exemplo 43151964000143

companyNamestring

Nome da empresa

Exemplo Empresa Teste

financierTaxIdstring

CNPJ do financiador

Exemplo 12345678000190

amounts object

Valores monetários do contrato de cobrança

requestedAmountnumber<double>

Valor solicitado

Exemplo 1500

effectivelyEncumberedAmountnumber<double>aceita valor nulo

Valor efetivamente onerado após confirmação do registrador

Exemplo 1450

acquirerTaxIdsstring[]

CNPJs de adquirentes relacionados ao contrato

paymentSchemesstring[]

Filtros de arranjo de pagamento relacionados ao contrato

bankingAddress object

Dados bancários vinculados ao contrato. Enquanto a conta não foi provisionada, state=PROCESSING e os demais campos vêm null.

statestring

Estado da provisão da conta de liquidação

Valores possíveis: [PROCESSING, PROVISIONED]

Exemplo PROVISIONED

taxIdstringaceita valor nulo

Documento vinculado à conta

Exemplo 43151964000143

ispbstringaceita valor nulo

ISPB do banco

Exemplo 12345678

branchstringaceita valor nulo

Agência

Exemplo 0001

accountstringaceita valor nulo

Conta com dígito

Exemplo 12345-6

bankNamestringaceita valor nulo

Nome do banco

Exemplo Banco Teste

strategystring

Estratégia de cobrança

Valores possíveis: [TURBO, SELECTIVE, SELECTIVE_WITH_DEBIT, SNIPER, DYNAMIC]

Exemplo SELECTIVE

firstSettlementDatestring<date>

Data inicial de liquidação dos recebíveis

Exemplo 2026-04-20

lastSettlementDatestring<date>

Data final de liquidação dos recebíveis

Exemplo 2026-04-25

createdAtstring<date-time>

Data/hora de criação em UTC

Exemplo 2026-04-23T18:45:00Z

updatedAtstring<date-time>aceita valor nulo

Data/hora da última atualização em UTC

Exemplo 2026-04-23T19:45:00Z

cancellation object

Dados de cancelamento do contrato

contractRegisterIdstringaceita valor nulo

Identificador do contrato no registrador

Exemplo REG-123

cancelledAtstring<date-time>aceita valor nulo

Data/hora de cancelamento em UTC

Exemplo 2026-04-23T20:00:00Z

receiptstringaceita valor nulo

Comprovante de baixa do gravame

Exemplo receipt-123

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_CollectionDetailResponse

{
  "collectionId": "22222222-2222-4222-8222-222222222222",
  "externalContractId": "ext-col-001",
  "externalId": "ext-op-001",
  "status": "CREATED",
  "company": {
    "companyTaxId": "43151964000143",
    "companyName": "Empresa Teste"
  },
  "financierTaxId": "12345678000190",
  "amounts": {
    "requestedAmount": 1500,
    "effectivelyEncumberedAmount": 1450
  },
  "acquirerTaxIds": [
    "01027058000191"
  ],
  "paymentSchemes": [
    "MCC"
  ],
  "bankingAddress": {
    "state": "PROVISIONED",
    "taxId": "43151964000143",
    "ispb": "12345678",
    "branch": "0001",
    "account": "12345-6",
    "bankName": "Banco Teste"
  },
  "strategy": "SELECTIVE",
  "firstSettlementDate": "2026-04-20",
  "lastSettlementDate": "2026-04-25",
  "createdAt": "2026-04-23T18:45:00Z",
  "updatedAt": "2026-04-23T19:45:00Z",
  "cancellation": {
    "contractRegisterId": "REG-123",
    "cancelledAt": "2026-04-23T20:00:00Z",
    "receipt": "receipt-123"
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}