Before you start
- Your organization ID and delegate ID.
GET /v1/organizationreturns the organization’sid, andGET /v1/organizations/{organizationId}/delegateslists your delegates with theirdelegateId, as Delegates shows. The examples set them as$ORGANIZATION_IDand$DELEGATE_ID. - An API key with
readto read the configuration andcp:adminto prepare a change. Only an admin of your organization can grantcp:admin. Authentication explains scopes. - The capital provider admin wallet. On-chain, the delegate keeps its admins under the identifier
issuerAdmins, so the API names this walletissuerAdminAddress. Only an admin wallet can make a change. The examples use0x1111111111111111111111111111111111111111. - ETH for gas in that wallet.
1. Read the current configuration
GET /v1/organizations/{organizationId}/delegates/{delegateId}/admin/state returns the delegate’s configuration as it is on-chain now. Add rwa, stablecoin, account, or issuerAdminAddress to check one address against the delegate’s RWA whitelist, stablecoin whitelist, blacklist, or admins. Here you confirm that USTB is whitelisted and that your wallet is an admin.
Response
rwaWhitelisted and isIssuerAdmin appear because the request asked for them. Admin state describes every field.
2. Prepare the change
POST /v1/organizations/{organizationId}/delegates/{delegateId}/admin/prepare takes the network, the admin wallet that will send the transaction, and the action. A discount is set by the RWA’s ID, which deployment info lists, and a rate is a whole number of basis points in rateBps: 10 is 0.1%.
Response
3. Check the result
checks tells you whether the transaction would succeed if sent now:
isIssuerAdminis whetherissuerAdminAddressis an admin of the delegate.simulation.passedis whether the transaction succeeds when run against the current chain state. When it fails,simulation.errorsays why, and the transaction’sgasandserializedarenull.
Response
4. Sign and send the transaction
Signtransaction with the wallet in transaction.from, your capital provider admin wallet, and send it to Ethereum mainnet. It is the only transaction the change needs. It is complete: the API filled in the wallet’s next nonce, the gas limit, and current fees, so sign serialized as returned, or the fields unchanged, and don’t set the nonce or fees yourself. Sign it within a few blocks; if the wallet sends another transaction first, or the fees have risen, prepare again.
5. Confirm the change
Once the transaction is in a block, check its receipt:status 1 means the change is live, and 0 means it reverted and nothing changed, so prepare again and check checks before you resend. Read the configuration again, as in step 1, to confirm a whitelist, custody, cold storage, pause, blacklist, or admin change. A rate, such as this discount, is not part of the admin state; the transaction’s inclusion is the confirmation.
When something goes wrong
Errors lists every code.