Skip to Content

Settings

GET/settings

Description

Retrieve your business configuration: business mode (test or live), per-chain signer status, and the addresses you need to integrate, including your PaymentFactory address (required to sign direct payments) and your settlement address.

These values are stable. Fetch them once and store them with your config. You can also view them in your dashboard.

Headers

HeaderDescriptionRequired
AuthorizationBearer token with your API keyyes

Example Request

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

Response

SUCCESSFUL RESPONSE
{
  "business_name": "Acme Store",
  "is_test": false,
  "can_generate_key": false,
  "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
    }
  ]
}

Response Fields

FieldTypeDescription
business_namestringYour business name.
is_testbooleantrue for a test business (testnets), false for a live business (mainnet).
can_generate_keybooleanWhether you can still generate a signing key for this business.
chain_configsarrayOne entry per chain family (evm, solana).
chain_configs[].chain_familystring'evm' or 'solana'.
chain_configs[].signer_statusstring'not_configured', 'pending_activation', or 'active'. The addresses below are filled in as the config progresses to active.
chain_configs[].merchant_signerstring | nullThe signing-key address registered for this chain family.
chain_configs[].settlement_addressstring | nullWhere settled funds are sent for this chain family.
chain_configs[].factory_addressstring | nullEVM only: your PaymentFactory address, needed to sign direct payments. null until the config is active; always null for Solana (program-bound).

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