Retrieve merchant settings

GET/settings

Retrieve your business configuration: test/live mode, per-chain signer status, the PaymentFactory address needed to sign direct payments, and the settlement address. These values are stable — fetch once and cache them with your config. It also returns your merchant id and one SubscriptionManager address per chain.

Headers

Header	Description	Required
Authorization	Bearer token with your secret API key	yes

Example Request

Request

const response = await fetch('https://checkout-api.exodus.com/settings', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
  },
});

Responses

Status	Description
200	The merchant settings.
400	Validation error
401	Missing or invalid authentication
403	API key lacks the required scope

Response body

Field	Type	Required	Description
business_id	string	yes	Your Exodus business id. Stable for the life of the business and also returned as business_id on subscription checkouts.
business_name	string	yes	Your registered business name, set by Exodus during onboarding. Hosted checkout and subscribe pages show display_name instead when it is set.
display_name	string \| null	yes	The name your customers see on hosted checkout and subscribe pages. null shows business_name instead.
background_color	string \| null	yes
primary_color	string \| null	yes
is_test	boolean	yes
settlement_type	enum: CRYPTO \| FIAT	yes
currency	string \| null	yes
settlement_provider	string \| null	yes
settlement_provider_id	string \| null	yes
chain_configs	object[]	yes
can_generate_key	boolean	yes
webhook_url	string \| null	yes
merchant_id	string	yes	The merchant id bound into your PaymentFactory and SubscriptionManager contracts: keccak256 of `merchant:<business_id>`.
subscription_managers	object[]	yes	Your SubscriptionManager contract addresses, one entry per chain where one is deployed, each with its CAIP-2 chain id.

chain_configs

Field	Type	Required
chain_family	enum: evm \| solana	yes
signer_status	enum: not_configured \| pending_activation \| active	yes
merchant_signer	string \| null	yes
settlement_address	string \| null	yes
factory_address	string \| null	yes

subscription_managers

Field	Type	Required	Description
chain	string	yes
address	string	yes

Example Response

{
  "business_id": "clzk3n8x50000qw3f7h2p9r1b",
  "business_name": "Acme Store",
  "display_name": null,
  "background_color": null,
  "primary_color": null,
  "is_test": false,
  "settlement_type": "CRYPTO",
  "currency": null,
  "settlement_provider": null,
  "settlement_provider_id": null,
  "chain_configs": [
    {
      "chain_family": "evm",
      "signer_status": "active",
      "merchant_signer": "0x1234abcd1234abcd1234abcd1234abcd1234abcd",
      "settlement_address": "0xabcd1234abcd1234abcd1234abcd1234abcd1234",
      "factory_address": "0xfaceb00cfaceb00cfaceb00cfaceb00cfaceb00c"
    },
    {
      "chain_family": "solana",
      "signer_status": "active",
      "merchant_signer": "9xQeWvG816bUx9EPjHmaT23yvVM2ZWbrrpZb9PusVFin",
      "settlement_address": "5tzFkiKscXHK5ZXCGbXZxdw7gTjjD1mBwuoFbhUvuAi9",
      "factory_address": null
    }
  ],
  "can_generate_key": false,
  "webhook_url": "https://yoursite.com/webhooks/exodus",
  "merchant_id": "0x750ba0a7160fc57611beb7d07de10a83425eb034e2daf679f7069347751ab566",
  "subscription_managers": [
    {
      "chain": "eip155:42161",
      "address": "0x9a1b2c3d4e5f60718293a4b5c6d7e8f901234567"
    }
  ]
}

Error Response

Error (e.g. 400)

{
  "error": {
    "type": "validation_error",
    "message": "amount must be a positive number",
    "param": "amount"
  }
}

Declare the SubscriptionManager pause authority Register a merchant signer and settlement address