Skip to main content
PUT
Set a local deposit-account label

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Path Parameters

instrumentID
string<uuid>
required

Body

application/json
label
string
required
Maximum string length: 60

Response

Label updated; an empty label clears it.

instrument_id
string<uuid>
account_id
string<uuid>
country
string
currency
string
method
string
purpose
enum<string>

Deposit destination purpose.

Available options:
fondeo,
banking
label
string

Optional local nickname for company operating destinations.

Maximum string length: 60
alias_pending
boolean

True for an AR company CVU created before its bank alias is selected.

instrument
string

The deposit destination to share with payers (e.g. the CLABE).

details
object
status
enum<string>
Available options:
active,
disabled
created_at
string<date-time>