taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

patch-management-instances-INSTANCE.rst (3306B)

      1 .. http:patch:: /management/instances/$INSTANCE
      2 .. http:patch:: [/instances/$INSTANCE]/private
      3 
      4   Update the configuration of a merchant instance.  PATCH operations against
      5   an instance are authenticated by checking that an authorization is provided
      6   that matches either the credential required by the instance being modified
      7   OR the ``admin`` instance, depending on the access path used.
      8 
      9   **Required permission:** ``instances-token-write``
     10 
     11   **Request**
     12 
     13   The request must be a `InstanceReconfigurationMessage`.
     14   Removing an existing ``payto_uri`` deactivates
     15   the account (it will no longer be used for future contracts).
     16 
     17   **Response:**
     18 
     19   :http:statuscode:`204 No content`:
     20     The backend has successfully created the instance.
     21   :http:statuscode:`404 Not found`:
     22     This instance is unknown and thus cannot be reconfigured.
     23 
     24   **Details:**
     25 
     26   .. ts:def:: InstanceReconfigurationMessage
     27 
     28     interface InstanceReconfigurationMessage {
     29 
     30       // Merchant name corresponding to this instance.
     31       name: string;
     32 
     33       // Merchant email for customer contact and password reset.
     34       email?: string;
     35 
     36       // Merchant phone number for password reset (2-FA)
     37       // @since **v21**.
     38       phone_number?: string;
     39 
     40       // Merchant public website.
     41       website?: string;
     42 
     43       // Merchant logo.
     44       logo?: ImageDataUrl;
     45 
     46       // The merchant's physical address (to be put into contracts).
     47       address: Location;
     48 
     49       // The jurisdiction under which the merchant conducts its business
     50       // (to be put into contracts).
     51       jurisdiction: Location;
     52 
     53       // Use STEFAN curves to determine default fees?
     54       // If false, no fees are allowed by default.
     55       // Can always be overridden by the frontend on a per-order basis.
     56       use_stefan: boolean;
     57 
     58       // If the frontend does NOT specify a payment deadline, how long should
     59       // offers we make be valid by default?
     60       // A value of "forever" is not allowed.
     61       // Optional @since **v22** (before the setting was mandatory).
     62       // If not provided, the previous setting will now simply be preserved.
     63       default_pay_delay?: RelativeTime;
     64 
     65       // If the frontend does NOT specify a refund deadline, how long should
     66       // refunds be allowed by default? Added on top of the payment deadline.
     67       // A value of "forever" is not allowed.
     68       // @since **v22**
     69       default_refund_delay?: RelativeTime;
     70 
     71       // If the frontend does NOT specify an execution date, how long should
     72       // we tell the exchange to wait to aggregate transactions before
     73       // executing the wire transfer?  This delay is added on top of
     74       // the refund deadline and afterwards subject to rounding
     75       // via the ``default_wire_transfer_rounding_interval``.
     76       // A value of "forever" is not allowed.
     77       // Optional @since **v22** (before the setting was mandatory).
     78       // If not provided, the previous setting will now simply be preserved.
     79       default_wire_transfer_delay?: RelativeTime;
     80 
     81       // How far should the wire deadline (if computed with the help of
     82       // the ``default_wire_transfer_delay``) be rounded up to compute
     83       // the ultimate wire deadline?
     84       // @since **v22**, defaults to no rounding if not given.
     85       default_wire_transfer_rounding_interval?: RoundingInterval;
     86     }