taler-docs

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

get-charity-CHARITY_ID.rst (968B)

      1 .. http:get:: /charity/$CHARITY_ID
      2 
      3   Request information about a specific charity.
      4   Only allowed if the request comes with a signature by
      5   the respective charity.
      6 
      7   **Request:**
      8 
      9   *Charity-Signature*:
     10 
     11     The client must provide Base-32 encoded EdDSA signature with
     12     ``$CHARITY_PRIV``, affirming the desire to obtain the charity status.
     13     Note that this is merely a simple authentication mechanism,
     14     the details of the request are not protected by the signature.
     15     The ``$CHARITY_PRIV`` is usually the merchant instance
     16     private key.
     17 
     18   **Response:**
     19 
     20   :http:statuscode:`200 OK`:
     21     The Donau responds with a `Charity` object
     22   :http:statuscode:`404 Not found`:
     23     The charity id does not belong to a charity known to the Donau.
     24 
     25   .. ts:def:: Charity
     26 
     27     interface Charity {
     28       charity_pub: EddsaPublicKey;
     29       name: string;
     30       url: string;
     31       max_per_year: Amount;
     32       receipts_to_date: Amount;
     33       current_year: Integer;
     34     }