Rename, disable or enable a deposit address

PATCH/v1/deposit_addresses/{id}

Changes this network’s object only. A disabled address is still watched: payments to it are recorded.

Authorization

Send your API key as a bearer token in the Authorization header. Secret API key: Authorization: Bearer ctp_live_sk_…. A publishable key (ctp_…_pk_…) is accepted by these operations only, which serve reference data: getRate, listAssets, listNetworks (each marked x-publishable-key: true). Every other operation refuses it with 403 publishable_key_not_allowed, whatever Origin the request carries: that header binds browsers, not other clients, and nothing on this API relies on it.

Path parameters

Name	Type	Description
`id` required	string	At most 100 characters.

Request body

Field	Type	Description
`name`	string	At most 64 characters.
`status`	string	One of `active`, `disabled`.

curl -X PATCH "https://api.ctpeway.com/v1/deposit_addresses/{id}" \
  -H "Authorization: Bearer $CTPEWAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Customer 42 (closed)",
  "status": "disabled"
}'

import { CtpeWay } from '@ctpeway/sdk';

const ctpeway = new CtpeWay(process.env.CTPEWAY_API_KEY);

const result = await ctpeway.depositAddresses.update('<id>', {
  name: 'Customer 42 (closed)',
  status: 'disabled',
});

Response

200 OK

Field	Type	Description
`id`	string
`name` optional	string
`network`	string
`address`	string
`status`	string	One of `active`, `disabled`, `archived`.
`created_at`	string (date-time)
`totals`	object	What this address received on its network. Confirmed payments only: detected, orphaned and dropped payments are not counted.
`totals.payments`	integer	Confirmed payments received.
`totals.usd_value`	string	Their value in USD, each at the price it confirmed at. A decimal number written as a string, with up to 8 decimal places.
`totals.last_payment_at` optional	string (date-time)	When the latest confirmed payment was detected. Absent while there is none.
`totals.received`	array of objects	One entry per asset received, by asset symbol.
`totals.received[].asset`	string	Asset symbol, e.g. `USDT`.
`totals.received[].asset_id`	string
`totals.received[].contract` optional	string
`totals.received[].decimals`	integer
`totals.received[].amount`	string	Sum of the confirmed payments in this asset, base units. A whole number written as a string of digits.
`totals.received[].usd_value`	string	Their value in USD, each at the price it confirmed at. A decimal number written as a string, with up to 8 decimal places.
`totals.received[].payments`	integer	Confirmed payments in this asset.
`livemode`	boolean	`false` for objects of the test environment.

{
  "id": "string",
  "name": "string",
  "network": "string",
  "address": "string",
  "status": "active",
  "created_at": "2026-01-01T00:00:00.000Z",
  "totals": {
    "payments": 0,
    "usd_value": "10.00",
    "last_payment_at": "2026-01-01T00:00:00.000Z",
    "received": [
      {
        "asset": "string",
        "asset_id": "string",
        "contract": "string",
        "decimals": 0,
        "amount": "1000000",
        "usd_value": "10.00",
        "payments": 0
      }
    ]
  },
  "livemode": true
}

The values are placeholders generated from the schema. They show the shape, not real data.

Errors

A failed request answers with the error format described under Errors.

Besides the codes any endpoint can return, this endpoint can answer with these code values: