Skip to Content
CheckoutAPI ReferenceSettingsRetrieve merchant settings

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.

Headers

HeaderDescriptionRequired
AuthorizationBearer token with your secret API keyyes

Example Request

Request

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

Responses

StatusDescription
200The merchant settings.
400Validation error
401Missing or invalid authentication

Response body

FieldTypeRequiredDescription
business_idstringyes
business_namestringyes
is_testbooleanyes
settlement_typeenum: CRYPTO | FIATyes
currencystring | nullyes
settlement_providerstring | nullyes
settlement_provider_idstring | nullyes
chain_configsobject[]yes
can_generate_keybooleanyes
webhook_urlstring | nullyes

chain_configs

FieldTypeRequiredDescription
chain_familyenum: evm | solanayes
signer_statusenum: not_configured | pending_activation | activeyes
merchant_signerstring | nullyes
settlement_addressstring | nullyes
factory_addressstring | nullyes

Example Response

{
  "business_id": "biz_1234567890abcdef",
  "business_name": "Acme Store",
  "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"
}

Error Response

Error (e.g. 400)

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

Start building

XO

Request Demo

Schedule a call with our team

Select a product
Arrow right

Start building
Grateful

Contact Us

We're here to help