Contents

GET [/instances/$INSTANCE]/private/pots/$POT_ID#

This is used to obtain detailed information about specific pot.

Required permission: pots-read

Response:

200 OK:

The backend has successfully returned the detailed information about a specific pot. Returns a PotDetailResponse.

400 Bad Request:

The pot ID parameter is malformed. Returned with TALER_EC_GENERIC_PARAMETER_MALFORMED.

404 Not found:

The pot or instance is unknown to the backend.

500 Internal Server Error:

The server experienced an internal failure. Returned with TALER_EC_GENERIC_DB_FETCH_FAILED.

Details:

interface PotDetailResponse {

  // Description of the pot. Possibly included
  // in the pot message.
  description: string;

  // Name of the pot. Must be unique per instance.
  pot_name: string;

  // Current total amount in the pot.
  pot_totals: Amount[];

}