taler-docs

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

post-private-pots.rst (795B)

      1 .. http:post:: [/instances/$INSTANCES]/private/pots
      2 
      3   This is used to create a pot.
      4 
      5   **Required permission:** ``pots-write``
      6 
      7   **Request:**
      8 
      9   The request must be a `PotAddRequest`.
     10 
     11   **Response:**
     12 
     13   :http:statuscode:`200 OK`:
     14     The backend has successfully added a new pot. Returns a `PotAddedResponse`.
     15 
     16   :http:statuscode:`404 Not found`:
     17     The merchant instance is unknown.
     18 
     19   **Details:**
     20 
     21   .. ts:def:: PotAddRequest
     22 
     23     interface PotAddRequest {
     24 
     25       // Description of the pot. Possibly included
     26       // in the pot message.
     27       description: string;
     28 
     29       // Name of the pot. Must be unique per instance.
     30       pot_name: string;
     31 
     32     }
     33 
     34   .. ts:def:: PotAddedResponse
     35 
     36     interface PotAddedResponse {
     37 
     38       // Unique ID for the pot.
     39       pot_serial_id: Integer;
     40 
     41     }