taler-docs

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

get-management-instances-INSTANCE.rst (3170B)

      1 .. http:get:: [/instances/$INSTANCE]/private
      2 .. http:get:: /management/instances/$INSTANCE
      3 
      4   This is used to query a specific merchant instance.  GET 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   This endpoint may be used even when mandatory TAN channels
     10   were not validated yet.
     11 
     12   **Required permission:** ``instances-read``
     13 
     14   **Response:**
     15 
     16   :http:statuscode:`200 OK`:
     17     The backend has successfully returned the list of instances stored. Returns
     18     a `QueryInstancesResponse`.
     19 
     20   **Details:**
     21 
     22   .. ts:def:: QueryInstancesResponse
     23 
     24     interface QueryInstancesResponse {
     25 
     26       // Merchant name corresponding to this instance.
     27       name: string;
     28 
     29       // Merchant email for customer contact and password reset.
     30       email?: string;
     31 
     32       // True if the ``email`` address was validated.
     33       // @since **v21**.
     34       email_validated?: boolean;
     35 
     36       // Merchant phone number for password reset (2-FA)
     37       // @since **v21**.
     38       phone_number?: string;
     39 
     40       // True if the ``email`` address was validated.
     41       // @since **v21**.
     42       phone_validated?: boolean;
     43 
     44       // Merchant public website.
     45       website?: string;
     46 
     47       // Merchant logo.
     48       logo?: ImageDataUrl;
     49 
     50       // Public key of the merchant/instance, in Crockford Base32 encoding.
     51       merchant_pub: EddsaPublicKey;
     52 
     53       // The merchant's physical address (to be put into contracts).
     54       address: Location;
     55 
     56       // The jurisdiction under which the merchant conducts its business
     57       // (to be put into contracts).
     58       jurisdiction: Location;
     59 
     60       // Use STEFAN curves to determine default fees?
     61       // If false, no fees are allowed by default.
     62       // Can always be overridden by the frontend on a per-order basis.
     63       use_stefan: boolean;
     64 
     65       // If the frontend does NOT specify a payment deadline, how long should
     66       // offers we make be valid by default? Added to the order creation
     67       // time.
     68       default_pay_delay: RelativeTime;
     69 
     70       // If the frontend does NOT specify a refund deadline, how long should
     71       // refunds be allowed by default? Added to the payment deadline.
     72       // @since **v22**
     73       default_refund_delay: RelativeTime;
     74 
     75       // If the frontend does NOT specify an execution date, how long should
     76       // we tell the exchange to wait to aggregate transactions before
     77       // executing the wire transfer?  This delay is added to the
     78       // refund deadline and subject to rounding to the
     79       // ``default_wire_transfer_rounding_interval``.
     80       default_wire_transfer_delay: RelativeTime;
     81 
     82       // Default interval to which wire deadlines computed by
     83       // adding the wire_transfer_delay on top of the refund
     84       // deadline should be rounded up to.
     85       // @since **v23**
     86       default_wire_transfer_rounding_interval: RoundingInterval;
     87 
     88       // Authentication configuration.
     89       // Does not contain the token when token auth is configured.
     90       auth: {
     91         method: "external" | "token";
     92       };
     93 
     94     }