Skip to main content
POST
Register a receivable's credit instrument at the registradora

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

receivableRef
string
obrigatório

The receivable this call is about, as an opaque identifier. Which format it carries belongs to the jurisdiction that booked it; nothing here parses it.

Required string length: 1 - 128

Corpo

application/json
fundId
string<uuid>
obrigatório

The fund whose registry configuration governs this registration.

Resposta

Accepted

commandReference
string
obrigatório

Our deterministic idempotency key for this command. Quoting it back reaches the same command, never a second one.

providerReference
string
obrigatório

The registry's own protocol number for this command.

receivableRef
string
obrigatório

The receivable the command is about.

replayed
boolean
obrigatório

True when the registry was NOT reached because this exact command had already been acknowledged.

state
string
obrigatório

requested (issued and acknowledged, waiting on the registry's acceptance), confirmed, or failed.