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

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

receivableRef
string
requerido

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

Cuerpo

application/json
fundId
string<uuid>
requerido

The fund whose registry configuration governs this registration.

Respuesta

Accepted

commandReference
string
requerido

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

providerReference
string
requerido

The registry's own protocol number for this command.

receivableRef
string
requerido

The receivable the command is about.

replayed
boolean
requerido

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

state
string
requerido

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