PATCH /management/instances/$INSTANCE

PATCH [/instances/$INSTANCE]/private

Update the configuration of a merchant instance. PATCH operations against an instance are authenticated by checking that an authorization is provided that matches either the credential required by the instance being modified OR the admin instance, depending on the access path used.

Required permission: instances-token-write

Request

The request must be a InstanceReconfigurationMessage. Removing an existing payto_uri deactivates the account (it will no longer be used for future contracts).

Response:

204 No content:

The backend has successfully created the instance.

404 Not found:

This instance is unknown and thus cannot be reconfigured.

Details:

interface InstanceReconfigurationMessage {

  // Merchant name corresponding to this instance.
  name: string;

  // Merchant email for customer contact and password reset.
  email?: string;

  // Merchant phone number for password reset (2-FA)
  // @since **v21**.
  phone_number?: string;

  // Merchant public website.
  website?: string;

  // Merchant logo.
  logo?: ImageDataUrl;

  // The merchant's physical address (to be put into contracts).
  address: Location;

  // The jurisdiction under which the merchant conducts its business
  // (to be put into contracts).
  jurisdiction: Location;

  // Use STEFAN curves to determine default fees?
  // If false, no fees are allowed by default.
  // Can always be overridden by the frontend on a per-order basis.
  use_stefan: boolean;

  // If the frontend does NOT specify a payment deadline, how long should
  // offers we make be valid by default?
  // A value of "forever" is not allowed.
  // Optional @since **v22** (before the setting was mandatory).
  // If not provided, the previous setting will now simply be preserved.
  default_pay_delay?: RelativeTime;

  // If the frontend does NOT specify a refund deadline, how long should
  // refunds be allowed by default? Added on top of the payment deadline.
  // A value of "forever" is not allowed.
  // @since **v22**
  default_refund_delay?: RelativeTime;

  // If the frontend does NOT specify an execution date, how long should
  // we tell the exchange to wait to aggregate transactions before
  // executing the wire transfer?  This delay is added on top of
  // the refund deadline and afterwards subject to rounding
  // via the default_wire_transfer_rounding_interval.
  // A value of "forever" is not allowed.
  // Optional @since **v22** (before the setting was mandatory).
  // If not provided, the previous setting will now simply be preserved.
  default_wire_transfer_delay?: RelativeTime;

  // How far should the wire deadline (if computed with the help of
  // the default_wire_transfer_delay) be rounded up to compute
  // the ultimate wire deadline?
  // @since **v22**, defaults to no rounding if not given.
  default_wire_transfer_rounding_interval?: RoundingInterval;
}