get-private-donau.rst (1473B)
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 16 **Details:** 17 18 .. ts:def:: DonauInstancesResponse 19 20 interface DonauInstancesResponse { 21 // List of linked charity instances 22 donau_instances: DonauInstance[]; 23 } 24 25 .. ts:def:: DonauInstance 26 27 interface DonauInstance { 28 // Serial number identifying the record inside the backend 29 donau_instance_serial: Integer; 30 31 // Base URL of the Donau service 32 donau_url: string; 33 34 // Human-readable charity name 35 charity_name: string; 36 37 // EdDSA public key of the charity (binary) 38 charity_pub_key: EddsaPublicKey; 39 40 // Charity identifier inside the Donau service 41 charity_id: Integer; 42 43 // Maximum donation amount per calendar year 44 charity_max_per_year: Amount; 45 46 // Cumulative receipts in the current year 47 charity_receipts_to_date: Amount; 48 49 // Calendar year the receipts refer to 50 current_year: Integer; 51 52 // Exchange-style ``/keys`` response published by Donau, 53 // missing if not yet known to the merchant backend. 54 donau_keys_json?: object; 55 }