Pular para o conteúdo principal
PATCH
Attach a cession document to the lot that took the contract

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Required idempotency key. Absent is 422, never a generated default.

Exemplo:

"idem-endorsement-1"

Parâmetros de caminho

fundo_id
string<uuid>
obrigatório

The id of a fund of the tenant's fund registry: the gateway's own or, when the registry is owned by the credit core, the id the core published; GET /v1/consignado/fundos lists them. It must be in the partner credential's scope.

Exemplo:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

numero_contrato
string
obrigatório

The contract a fund took into a lot.

Exemplo:

"99999999999AN1"

Corpo

application/json
documents
object[] | null
obrigatório

Exactly one cession-phase document: endorsed_credit_instrument, application/pdf, up to 5 MiB. An origination type is refused 422 DOCUMENT_PHASE_MISMATCH.

Required array length: 1 element

Resposta

OK

assignmentSetId
string<uuid>
obrigatório

The lot the contract's latest take belongs to.

Exemplo:

"0193a6f2-7c4e-7b1a-9d2e-5f8c3a1b2c3d"

documents
object[] | null
obrigatório

The documents retained for the lot and type sent: the stored record, new or replayed.

fundoRef
string
obrigatório

The fund that took the contract in that lot.

Exemplo:

"0192f1d0-4a2b-7c3d-8e9f-0a1b2c3d4e5f"

numeroContrato
string
obrigatório

The contract number the call was addressed to.

Exemplo:

"99999999999AN1"