GET /charities

GET all charities. Only allowed if the request comes with the administration bearer token.

return all charities

Request:

Response:

200 OK:

The request was successful, and the response is a Charities.

204 No Content:

No charities are registered at this time.

403 Forbidden:

The request did not contain an accepted administrator bearer token in its header. Returned with error code TALER_EC_GENERIC_TOKEN_PERMISSION_INSUFFICIENT.

500 Internal Server Error:

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

Details:

interface Charities{
  charities: CharitySummary[];
}

interface CharitySummary {

  // Unique ID of the charity within the Donau.
  charity_id: Integer;

  // Public key of the charity, used by the charity to
  // authorize issuing donation receipts.
  charity_pub: EddsaPublicKey;

  // Human-readable name of the charity.
  charity_name: string;

  // Maximum amount of donation receipts this charity is
  // allowed to issue per year.
  max_per_year: Amount;

  // Year for which receipts_to_date is given.
  current_year: Integer;

  // Total amount of donation receipts the donau has
  // issued for this charity so far this year.
  receipts_to_date: Amount;
}