taler-docs

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

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

      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   :http:statuscode:`401 Unauthorized`:
     20     The request is unauthorized.
     21   :http:statuscode:`404 Not found`:
     22     The instance is unknown.
     23     Returned with ``TALER_EC_MERCHANT_GENERIC_INSTANCE_UNKNOWN``.
     24 
     25   **Details:**
     26 
     27   .. ts:def:: QueryInstancesResponse
     28 
     29     interface QueryInstancesResponse {
     30 
     31       // Merchant name corresponding to this instance.
     32       name: string;
     33 
     34       // Merchant email for customer contact and password reset.
     35       email?: string;
     36 
     37       // True if the ``email`` address was validated.
     38       // @since **v21**.
     39       email_validated?: boolean;
     40 
     41       // Merchant phone number for password reset (2-FA)
     42       // @since **v21**.
     43       phone_number?: string;
     44 
     45       // True if the ``email`` address was validated.
     46       // @since **v21**.
     47       phone_validated?: boolean;
     48 
     49       // Merchant public website.
     50       website?: string;
     51 
     52       // Merchant logo.
     53       logo?: ImageDataUrl;
     54 
     55       // Public key of the merchant/instance, in Crockford Base32 encoding.
     56       merchant_pub: EddsaPublicKey;
     57 
     58       // The merchant's physical address (to be put into contracts).
     59       address: Location;
     60 
     61       // The jurisdiction under which the merchant conducts its business
     62       // (to be put into contracts).
     63       jurisdiction: Location;
     64 
     65       // Use STEFAN curves to determine default fees?
     66       // If false, no fees are allowed by default.
     67       // Can always be overridden by the frontend on a per-order basis.
     68       use_stefan: boolean;
     69 
     70       // If the frontend does NOT specify a payment deadline, how long should
     71       // offers we make be valid by default? Added to the order creation
     72       // time.
     73       default_pay_delay: RelativeTime;
     74 
     75       // If the frontend does NOT specify a refund deadline, how long should
     76       // refunds be allowed by default? Added to the payment deadline.
     77       // @since **v22**
     78       default_refund_delay: RelativeTime;
     79 
     80       // If the frontend does NOT specify an execution date, how long should
     81       // we tell the exchange to wait to aggregate transactions before
     82       // executing the wire transfer?  This delay is added to the
     83       // refund deadline and subject to rounding to the
     84       // ``default_wire_transfer_rounding_interval``.
     85       default_wire_transfer_delay: RelativeTime;
     86 
     87       // Default interval to which wire deadlines computed by
     88       // adding the wire_transfer_delay on top of the refund
     89       // deadline should be rounded up to.
     90       // @since **v23**
     91       default_wire_transfer_rounding_interval: RoundingInterval;
     92 
     93       // Bank accounts of the merchant instance.
     94       // FIXME: since when?
     95       accounts: BankAccountEntry[];
     96 
     97       // Authentication configuration.
     98       // Does not contain the token when token auth is configured.
     99       auth: {
    100         method: "external" | "token";
    101       };
    102 
    103     }