Pular para o conteúdo principal
PUT
Appoint the tenant's extraordinary-collection agent

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Canonical idempotency request ID. Required: this request moves money, and without a key a retry cannot be told apart from a second instruction.

Corpo

application/json
agentAccountId
string
obrigatório

The collection agent's own receiving account, held at the agent and never an account of the lender's: the agent receives the borrower's cash and the lender ingests the settlement file. It becomes the payment identity of every settlement of the instructions it stamps, so it admits no colon, whitespace or control character — "conta byx 001" is refused here, where a 422 costs nothing, instead of stranding a paid borrower's money later.

Required string length: 1 - 255
Pattern: ^[^\s:\x00-\x1f\x7f]+$
agentName
string
obrigatório

The collection agent, lowercase authority shape. It is stamped VERBATIM on every instruction and the baixa file quotes it back byte-exactly, so mixed case would issue instructions no file could answer.

Required string length: 1 - 100
Pattern: ^[a-z0-9][a-z0-9._-]{0,99}$
active
boolean

Defaults to true. False turns the channel OFF without deleting the agent's identity, returning issuance to the park; an instrument already issued still names the agent that received it.

handlesWithdrawal
boolean

Defaults to false on every appointment. True is the operador's word that this agent withdraws (baixa) a boleto when it receives collection.instruction.withdrawn, and that the Streaming Hub subscription feeding it carries collection_instruction.withdrawn. Only then does Lender withdraw a boleto this agent holds once the instalment is credited another way, and issue what the portador still owes as a new instruction; while false every boleto it holds stands.

Resposta

OK

active
boolean
obrigatório

True while the channel instructs; false parks issuance.

agentAccountId
string
obrigatório

The agent's receiving account.

agentName
string
obrigatório

The appointed collection agent.

handlesWithdrawal
boolean
obrigatório

True while Lender withdraws a boleto this agent holds through collection.instruction.withdrawn.