GET [/instances/$INSTANCE]/private/donau

Return all Donau charity instances currently linked to $INSTANCE.

Required permission: donau-read

Response:

200 OK:

Body is a DonauInstancesResponse.

401 Unauthorized:

Missing or invalid credentials.

404 Not found:

The merchant instance is unknown.

Details:

interface DonauInstancesResponse {
  // List of linked charity instances
  donau_instances: DonauInstance[];
}

interface DonauInstance {
  // Serial number identifying the record inside the backend
  donau_instance_serial: Integer;

  // Base URL of the Donau service
  donau_url: string;

  // Human-readable charity name
  charity_name: string;

  // EdDSA public key of the charity (binary)
  charity_pub_key: EddsaPublicKey;

  // Charity identifier inside the Donau service
  charity_id: Integer;

  // Maximum donation amount per calendar year
  charity_max_per_year: Amount;

  // Cumulative receipts in the current year
  charity_receipts_to_date: Amount;

  // Calendar year the receipts refer to
  current_year: Integer;

  // Exchange-style /keys response published by Donau,
  // missing if not yet known to the merchant backend.
  donau_keys_json?: object;
}