Remove a payout address - Hypermid

Remove a payout address

curl --request DELETE \
  --url https://server.hypermid.io/v1/payments/payout-addresses/{chain}/{address} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-hypermid-action-challenge: <x-hypermid-action-challenge>'

const options = {
  method: 'DELETE',
  headers: {
    'x-hypermid-action-challenge': '<x-hypermid-action-challenge>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://server.hypermid.io/v1/payments/payout-addresses/{chain}/{address}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://server.hypermid.io/v1/payments/payout-addresses/{chain}/{address}"

headers = {
    "x-hypermid-action-challenge": "<x-hypermid-action-challenge>",
    "Authorization": "Bearer <token>"
}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "OK",
  "error": null,
  "data": {
    "change": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "operation": "add",
      "chain": 123,
      "address": "<string>",
      "status": "pending",
      "requestedAt": "2023-11-07T05:31:56Z",
      "effectiveAt": "2023-11-07T05:31:56Z"
    }
  }
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

DELETE

/

v1

/

payments

/

payout-addresses

/

{chain}

/

{address}

Remove a payout address

curl --request DELETE \
  --url https://server.hypermid.io/v1/payments/payout-addresses/{chain}/{address} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-hypermid-action-challenge: <x-hypermid-action-challenge>'

const options = {
  method: 'DELETE',
  headers: {
    'x-hypermid-action-challenge': '<x-hypermid-action-challenge>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://server.hypermid.io/v1/payments/payout-addresses/{chain}/{address}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://server.hypermid.io/v1/payments/payout-addresses/{chain}/{address}"

headers = {
    "x-hypermid-action-challenge": "<x-hypermid-action-challenge>",
    "Authorization": "Bearer <token>"
}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "OK",
  "error": null,
  "data": {
    "change": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "operation": "add",
      "chain": 123,
      "address": "<string>",
      "status": "pending",
      "requestedAt": "2023-11-07T05:31:56Z",
      "effectiveAt": "2023-11-07T05:31:56Z"
    }
  }
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

Authorizations

Authorization

string

header

required

Secret partner API key (sk_live_… or sk_test_…). Required to create or manage payment sessions. Server-side only — it can move money, so it must never reach a browser bundle. The key's prefix also selects the environment: sk_test_ is confined to testnets.

Headers

x-hypermid-action-challenge

string

required

Fresh verified 2FA challenge bound to this exact remove.

Path Parameters

chain

string

required

address

string

required

Response

Payout address change accepted.

traceId

string

required

W3C trace id of the request — correlate with logs/traces in SigNoz.

Example:

"4bf92f3577b34da6a3ce929d0e0e4736"

code

enum<string>

required

Domain error code. OK on success; non-OK values come with a non-null error.

Available options:

OK,

BAD_REQUEST,

UNAUTHORIZED,

FORBIDDEN,

NOT_FOUND,

CONFLICT,

RATE_LIMITED,

PAYLOAD_TOO_LARGE,

UNSUPPORTED_CHAIN,

INTERNAL_ERROR,

UPSTREAM_TIMEOUT,

UPSTREAM_ERROR,

SERVICE_UNAVAILABLE,

KILL_SWITCH_ACTIVE,

CIRCUIT_BREAKER_OPEN,

NO_QUOTE_AVAILABLE,

QUOTE_STALE,

SIMULATION_REVERTED,

INVALID_PARAMS,

AMOUNT_OUT_OF_BOUNDS,

PAYOUT_TOKEN_NOT_ALLOWED,

RECIPIENT_NOT_ALLOWLISTED,

PAYMENT_EXPIRED,

PAYMENT_NOT_FOUND,

NOT_CONFIGURED,

INSUFFICIENT_LIQUIDITY,

ROUTE_TEMPORARILY_UNAVAILABLE,

UNSUPPORTED_ROUTE,

OVER_DELIVERY_CAP

Example:

"OK"

error

string | null

required

Human-readable error message. null on success.

Example:

null

data

object

required

Endpoint-specific payload. null on error.

Show child attributes