Sign in

v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-063469194.3 KB
Clients

Configure client settings

Configure webhook URL, secret, sponsorship, source-token whitelist, and app-fee rules for a project. Deposit whitelist keys must use CAIP-2 chain identifiers (for example "eip155:8453"). App-fee token overrides take precedence over the project fallback; feeBps 0 clears only the fallback, while appFees null clears fallback and overrides.

post/setup

Headers

x-api-keystring

API key for authentication (omit when sending Authorization)

Example:your-api-key

API key for authentication (omit when sending Authorization)

authorizationstring

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

Example:Bearer eyJhbGciOi...

Bearer platform token (e.g. forwarded by user-service). Takes precedence over x-api-key when both are present.

x-api-versionstring

API version identifier (e.g. "2026-04.amazon"). Optional today, will become required in a future release.

Example:2026-04.amazon

API version identifier (e.g. "2026-04.amazon"). Optional today, will become required in a future release.

Request body

Example request

{
  "params": {
    "depositWhitelist": {
      "eip155:8453": [
        {
          "token": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
          "minAmount": "1000000",
          "maxAmount": "5000000000"
        }
      ]
    },
    "maxPriceDeviationBps": 200,
    "minDepositUsd": 1,
    "appFees": {
      "feeBps": 100,
      "tokens": {
        "eip155:8453": [
          {
            "token": "0x4200000000000000000000000000000000000006",
            "feeBps": 200
          }
        ]
      }
    }
  }
}

Response

Client updated successfully

messagestring required