Ask for an invitation
Menu

Endpoint

Remove a saved address

DELETE/v1/saved_addresses/{id}

Takes effect at once and needs no further approval. Requests already awaiting_approval to it are cancelled. In live mode a key cannot remove a saved address: it answers passkey_approval_required with reason saved_address_dashboard_only and nothing changes, and a live address is removed in the dashboard with a passkey. Test mode is unchanged.

Scope a restricted key needs
payouts:write
Publishable key
Not allowed: secret or restricted key only
Idempotency-Key
Not used. A DELETE is already safe to repeat.

Parameters

Parameters of Remove a saved address
ParameterType and placeMeaning
idrequiredstringpathThe id of the saved address.
Orrerie-VersionstringheaderAPI version date. Default: the version the key was created with. Example 2026-10-11.

Example request

curl

curl -X DELETE https://api.orrerie.com/v1/saved_addresses/dst_92jw0br3z1bzkk45ddjqcm6q \
  -H "Authorization: Bearer $ORRERIE_SECRET_KEY"

JavaScript

const response = await fetch("https://api.orrerie.com/v1/saved_addresses/dst_92jw0br3z1bzkk45ddjqcm6q", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
  },
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);

Python

import os
import requests

response = requests.delete(
    "https://api.orrerie.com/v1/saved_addresses/dst_92jw0br3z1bzkk45ddjqcm6q",
    headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
    timeout=30,
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)

PHP

<?php
$request = curl_init('https://api.orrerie.com/v1/saved_addresses/dst_92jw0br3z1bzkk45ddjqcm6q');
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
    ],
]);
$body = curl_exec($request);
if ($body === false) {
    throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
    throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);

Responses

200 OK

The answer is the saved_address object. Headers: Orrerie-Request-Id.

Example response, 200

{
  "id": "dst_92jw0br3z1bzkk45ddjqcm6q",
  "object": "saved_address",
  "livemode": true,
  "created": "2026-10-05T11:20:00.000Z",
  "label": "Green bean supplier",
  "kind": "third_party",
  "address": "0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb",
  "network": "base",
  "asset": "base:usdc",
  "status": "removed",
  "approved_by": "mem_ceh1wpzdrpk13cnpcjy9w0fa",
  "approved_at": "2026-10-05T11:24:09.000Z",
  "usable_at": "2026-10-06T11:24:09.000Z",
  "screening": {
    "id": "scr_6ncr4e0p7wqndfvny2d5vw5s",
    "status": "clear",
    "checked_at": "2026-10-05T11:20:01.000Z"
  },
  "approval_url": null,
  "metadata": {}
}

Any other status: an error

A status of 400 or above answers with the error object. Branch on its code, never on its message.

Errors

Beside the errors every call can answer with (a bad key, a missing scope, the rate limit), this call answers with:

Errors of Remove a saved address
CodeHTTPMeaning
passkey_approval_required403The action can only be done by a signed-in member in the dashboard (settlement asset, key-holding roles, approvals). No API key can do it.