taler-docs

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

get-private-pots-POT_SERIAL.rst (777B)

      1 .. http:get:: [/instances/$INSTANCES]/private/pots/$POT_SERIAL
      2 
      3   This is used to obtain detailed information about specific pot.
      4 
      5   **Required permission:** ``pots-read``
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The backend has successfully returned the detailed information about a specific pot. Returns a `PotDetailResponse`.
     11 
     12   :http:statuscode:`404 Not found`:
     13     The pot or instance is unknown to the backend.
     14 
     15   **Details:**
     16 
     17   .. ts:def:: PotDetailResponse
     18 
     19     interface PotDetailResponse {
     20 
     21       // Description of the pot. Possibly included
     22       // in the pot message.
     23       description: string;
     24 
     25       // Name of the pot. Must be unique per instance.
     26       pot_name: string;
     27 
     28       // Current total amount in the pot.
     29       pot_totals: Amount[];
     30 
     31     }