taler-docs

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

get-private-donau.rst (1625B)

      1 .. http:get:: [/instances/$INSTANCE]/private/donau
      2 
      3   Return all Donau charity instances currently linked to ``$INSTANCE``.
      4 
      5   **Required permission:** ``donau-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     Body is a :ts:type:`DonauInstancesResponse`.
     11   :http:statuscode:`401 Unauthorized`:
     12     Missing or invalid credentials.
     13   :http:statuscode:`404 Not found`:
     14     The merchant instance is unknown.
     15   :http:statuscode:`500 Internal Server Error`:
     16     The server experienced an internal failure.
     17     Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
     18 
     19   **Details:**
     20 
     21   .. ts:def:: DonauInstancesResponse
     22 
     23     interface DonauInstancesResponse {
     24       // List of linked charity instances
     25       donau_instances: DonauInstance[];
     26     }
     27 
     28   .. ts:def:: DonauInstance
     29 
     30     interface DonauInstance {
     31       // Serial number identifying the record inside the backend
     32       donau_instance_serial: Integer;
     33 
     34       // Base URL of the Donau service
     35       donau_url: string;
     36 
     37       // Human-readable charity name
     38       charity_name: string;
     39 
     40       // EdDSA public key of the charity (binary)
     41       charity_pub_key: EddsaPublicKey;
     42 
     43       // Charity identifier inside the Donau service
     44       charity_id: Integer;
     45 
     46       // Maximum donation amount per calendar year
     47       charity_max_per_year: Amount;
     48 
     49       // Cumulative receipts in the current year
     50       charity_receipts_to_date: Amount;
     51 
     52       // Calendar year the receipts refer to
     53       current_year: Integer;
     54 
     55       // Exchange-style ``/keys`` response published by Donau,
     56       // missing if not yet known to the merchant backend.
     57       donau_keys_json?: object;
     58     }