GET /charity/$CHARITY_ID

Request information about a specific charity. Only allowed if the request comes with a signature by the respective charity.

Request:

Charity-Signature:

The client must provide Base-32 encoded EdDSA signature with $CHARITY_PRIV, affirming the desire to obtain the charity status. Note that this is merely a simple authentication mechanism, the details of the request are not protected by the signature. The $CHARITY_PRIV is usually the merchant instance private key.

Response:

200 OK:

The Donau responds with a Charity object.

400 Bad Request:

The $CHARITY_ID is malformed or the required Charity-Signature header is missing or cannot be parsed. Returned with error code TALER_EC_GENERIC_PARAMETER_MALFORMED or TALER_EC_GENERIC_PARAMETER_MISSING.

403 Forbidden:

The charity signature provided in the Charity-Signature header is invalid. Returned with error code TALER_EC_GENERIC_FORBIDDEN.

404 Not Found:

The charity ID does not belong to a charity known to the Donau. Returned with error code TALER_EC_DONAU_CHARITY_NOT_FOUND.

500 Internal Server Error:

The Donau encountered an internal database error. Returned with error code TALER_EC_GENERIC_DB_FETCH_FAILED.

interface Charity {
  charity_pub: EddsaPublicKey;
  name: string;
  url: string;
  max_per_year: Amount;
  receipts_to_date: Amount;
  current_year: Integer;
}