Sign in

v1

latestOpenAPI 3.0.02026-07-22290108.6 KB
Client IDs
V2/Client IDs

Update a client ID

Update client ID settings including domains and rate limits

put/v2/client-ids/{id}

Path parameters

idstring required
Example:123

Client ID internal identifier

Headers

x-api-keystring required

API key for authentication

Request body

labelstring
allowedDomainsstring[]

List of allowed domain origins (normalized)

feePercentagestring nullable

Fee percentage (e.g., '1' = 1%, '2.5' = 2.5%, '2.55' = 2.55%). Maximum 2 decimal places. If set to '0', allows API request fees to take precedence. If set to any other value, overrides any fee passed via API. Set to null to unset.

feeAddressstring nullable

Wallet address to receive fees. Required if feePercentage is set. Set to null to unset.

operatorWalletAddressstring nullable

Wallet address that will act as operator for commerce payments. The API operator wallet will execute transactions on behalf of this address. Can be a smart wallet that has granted permissions to the API operator. Set to null to unset. Note: Changing this will only affect new payments; existing payments will continue using their original operator address.

defaultPreApprovalExpiryinteger nullable

Default pre-approval expiry duration in seconds for commerce transactions. If set, overrides the value passed in /v2/commerce-payments/authorize/calldata endpoint. Set to null to unset.

defaultAuthorizationExpiryinteger nullable

Default authorization expiry duration in seconds for commerce transactions. If set, overrides the value passed in /v2/commerce-payments/authorize/calldata endpoint. Set to null to unset.

status'active' | 'inactive' | 'revoked'

Response

Client ID updated successfully

idstring
clientIdstring
labelstring
allowedDomainsstring[]
feePercentagestring nullable
feeAddressstring nullable
operatorWalletAddressstring nullable
defaultPreApprovalExpirynumber nullable
defaultAuthorizationExpirynumber nullable
statusstring
updatedAtstring