Update an on-chain settlement address

PUT/payments/settlement

Change the wallet address that captured funds settle to for a chain. Takes effect immediately for future captures. Requires a signed request (signSettlementChange()) against the chain's settlement contract and its current nonce, which increments on each successful change.

Headers

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

Request Body

Field	Type	Required	Description
new_address	string	yes
chain	string	yes

Example Request

Request

const response = await fetch('https://checkout-api.exodus-int.com/payments/settlement', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer sk_live_xxxxxxxxxxxxxxxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "new_address": "string",
    "chain": "string"
  }),
});

Responses

Status	Description
200	The updated settlement address and its on-chain nonce.
400	Validation error
401	Missing or invalid authentication

Response body

Field	Type	Required
address	string	yes
chain	string	yes
nonce	number	yes
tx_hash	string	yes

Example Response

{
  "address": "0xabcd1234abcd1234abcd1234abcd1234abcd1234",
  "chain": "eip155:1",
  "nonce": 2,
  "tx_hash": "0x8a9c67b2d1e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9"
}

Error Response

Error (e.g. 400)

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

List on-chain settlement addresses Overview