Generated SDK #7742 (major)

[sdk-generation-automation]

Changelog

2026-05-17

Breaking Change

Rename usdc_gateway endpoints to circle_gateway

Products: Vaults

Scope: API + SDKs

• What's new
  The Circle Gateway wallet endpoints have been renamed from /usdc_gateway to /circle_gateway across all three gateway operations. The operationIds and summaries have been updated to reflect the Circle Gateway branding.

• Impact
  Update all client code to use the new /vault/accounts/{vaultAccountId}/circle_gateway URL paths and the renamed operation IDs (getCircleGatewayWalletInfoBeta, activateCircleGatewayWalletBeta, deactivateCircleGatewayWalletBeta).

Affected endpoints:

1. Get Circle Gateway wallet info
2. Activate a Circle Gateway wallet
3. Deactivate a Circle Gateway wallet

Rename vault gateway endpoints from usdc_gateway to circle_gateway

Products: Vaults

Scope: API + SDKs

• What's new
  The vault gateway wallet endpoints have been renamed from /usdc_gateway to /circle_gateway across all three gateway operations, with corresponding updates to endpoint paths, summaries, and operationIds. This affects the get info, activate, and deactivate Circle Gateway wallet operations.

• Impact
  Update all client code to use the new /vault/accounts/{vaultAccountId}/circle_gateway URL paths and the renamed operationIds; existing integrations using the /usdc_gateway paths and previous operationIds will break.

Affected endpoints:

1. Get Circle Gateway wallet info
2. Activate a Circle Gateway wallet
3. Deactivate a Circle Gateway wallet

Update TRLink customer schemas to match server behavior

Products: TRLink

Scope: API + SDKs

• What's new
  The TRLink customer schemas have been updated to reflect actual server behavior: tenantId has been removed from responses, trPrimaryPurpose is now required and non-nullable in responses with a default of trlink, and shortName is now required in update requests. These changes ensure the OpenAPI specification accurately describes server-side validation and data contracts.

• Impact
  Remove any code relying on tenantId in customer responses, always include shortName in update requests, and handle trPrimaryPurpose as a guaranteed non-null string in all customer response payloads.

Affected endpoints:

1. Create customer
2. Get all customers
3. Get customer by ID
4. Update customer

Rename circle_gateway endpoints to usdc_gateway

Products: Vaults

Scope: API + SDKs

• What's new
  The USDC Gateway wallet endpoints have been renamed from /circle_gateway to /usdc_gateway across all three gateway operations. The operationIds and summaries have been updated to reflect the USDC Gateway branding.

• Impact
  Update all client code to use the new /vault/accounts/{vaultAccountId}/usdc_gateway URL paths and the renamed operation IDs (getUsdcGatewayWalletInfoBeta, activateUsdcGatewayWalletBeta, deactivateUsdcGatewayWalletBeta).

Affected endpoints:

1. Get USDC Gateway wallet info
2. Activate a USDC Gateway wallet
3. Deactivate a USDC Gateway wallet

Remove POL and POL_TEST from staking chainDescriptor parameter

Products: Staking

Scope: API + SDKs

• What's new
  The POL and POL_TEST enum values have been removed from the shared ChainDescriptor schema and from the claimRewards endpoint's inline path parameter enum. Clients sending POL or POL_TEST as a chainDescriptor value to any affected staking endpoint will receive a validation error.

• Impact
  Update any integrations using POL or POL_TEST as a staking chain descriptor and migrate to MATIC for Polygon staking reward claims.

Affected endpoints:

1. Claim accrued rewards
2. Get chain-level staking parameters
3. Initiate or add to existing stake
4. Initiate unstake
5. List staking positions
6. List staking positions (Paginated)
7. Withdraw staked funds

Remove selectionStrategy from UtxoSelectionParams schema

Products: Transactions

Scope: API + SDKs

• What's new
  The selectionStrategy property (accepting AMOUNT_ASC or AMOUNT_DESC values) has been removed from the UtxoSelectionParams schema used in transaction request bodies. This field previously allowed an optional override of the UTXO selection strategy configured at the vault or tenant level.

• Impact
  Remove any usage of utxoSelectionParams.selectionStrategy from transaction creation or fee estimation request bodies, as the field is no longer accepted.

Affected endpoints:

1. Create a new transaction
2. Estimate transaction fee

Remove Genie (Beta) AI assistant API endpoints

Products: Genie (Beta)

Scope: API + SDKs

• What's new
  The POST /genie/sessions and POST /genie/sessions/{sessionId}/messages endpoints have been removed from the public API. Clients relying on these endpoints to create AI-powered conversation sessions or send messages to the Genie assistant must migrate to an alternative solution.

• Impact
  Any client code calling the Genie endpoints will receive errors. Remove or update integrations that reference createGenieSession or sendGenieMessage.

Affected endpoints:

1. Create a Genie session
2. Send a message to a Genie session

Remove orderCreationRequirements from QuotePropertiesDetails schema

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  The orderCreationRequirements field has been removed from the QuotePropertiesDetails schema returned by the create quote endpoint. Clients that previously relied on this field to pre-validate order creation payloads must update their integrations.

• Impact
  Remove any code that reads or depends on the orderCreationRequirements field from quote responses.

Affected endpoints:

1. Create a quote

Added

Add vault account lookup by blockchain address endpoint

Products: Vaults

Scope: API + SDKs

• What's new
  A new beta endpoint GET /vault/lookup_by_address resolves a blockchain address to the vault account that owns it, returning the vault account ID and associated blockchains. This enables efficient reverse-lookup of any blockchain address without iterating across all vault accounts.

• Impact
  Use the new lookupVaultByAddress endpoint with the address query parameter to resolve a blockchain address to its owning vault account.

Affected endpoints:

1. Look up a vault account by blockchain address

Add ARS screening activation and deactivation endpoints

Products: Compliance

Scope: API + SDKs

• What's new
  Two new endpoints enable tenants to programmatically activate and deactivate Address Registry Screening (ARS) for their account. Once activated, ARS screening is applied to matching transactions.

• Impact
  Use the /screening/ars/config/activate and /screening/ars/config/deactivate endpoints to control ARS screening state for your tenant.

Affected endpoints:

1. Activate ARS (Address Registry Screening)
2. Deactivate ARS (Address Registry Screening)

Add optional selectionStrategy field to UtxoSelectionParams

Products: Transactions

Scope: API + SDKs

• What's new
  A new optional selectionStrategy field has been added to the UtxoSelectionParams schema, accepting values AMOUNT_ASC or AMOUNT_DESC. This allows clients to override the UTXO selection strategy configured at the vault or tenant level on a per-request basis.

• Impact
  Use the selectionStrategy field within utxoSelectionParams when creating or estimating transactions to control which UTXOs are prioritized for selection, without changing vault or tenant-level defaults.

Affected endpoints:

1. Create a new transaction
2. Estimate transaction fee

Add optional type field to Tag schema responses

Products: Tags

Scope: API + SDKs

• What's new
  A new optional type field has been added to the Tag schema, indicating the domain that owns the tag (e.g., WALLET_POOL). This field is returned in all endpoints that respond with Tag objects.

• Impact
  Clients receiving Tag objects can now inspect the type field to identify system-managed tags; no existing integrations are broken by this addition.

Affected endpoints:

1. Create a new tag
2. Get a tag
3. Get list of tags
4. Update a tag

Add Genie session and messaging endpoints

Products: Genie (Beta)

Scope: API + SDKs

• What's new
  Two new endpoints under /genie/sessions enable creating conversation sessions, sending natural-language messages. This gives developers programmatic access to Genie's AI assistant capabilities via the API.

• Impact
  Use the new endpoints to create sessions, submit queries. No changes are required for existing integrations.

Affected endpoints:

1. Create a Genie session
2. Send a message to a Genie session

Add optional sourceOfFunds field to create order request

Products: Trading (Beta)

Scope: API + SDKs

• What's new
  A new optional sourceOfFunds object with a reasonForPayment enum has been added to the POST /trading/orders request body. This enables providers requiring categorical payment purpose data (e.g. CPN for cross-border compliance) to receive structured source-of-funds context.

• Impact
  Clients may optionally include sourceOfFunds.reasonForPayment when creating an order; no changes are required for existing integrations.

Affected endpoints:

1. Create an order

---

[github-actions]

Your request is important to us. We will look into it shortly. (Note that this SDK code is auto generated)