taler-docs

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

get-exchanges.rst (1187B)

      1 .. http:get:: /exchanges
      2 
      3   Return information about exchanges configured for this merchant backend.
      4   @since **v26**.
      5 
      6   **Response:**
      7 
      8   :http:statuscode:`200 OK`:
      9     The body is a `ExchangeStatusResponse`.
     10 
     11   **Details:**
     12 
     13   .. ts:def:: ExchangeStatusResponse
     14 
     15     interface ExchangeStatusResponse {
     16 
     17       exchanges: ExchangeStatusDetail[];
     18 
     19     }
     20 
     21   .. ts:def:: ExchangeStatusDetail
     22 
     23     interface ExchangeStatusDetail {
     24 
     25       // Base URL of the exchange this is about.
     26       exchange_url: string;
     27 
     28       // Time when the backend will download ``/keys`` next.
     29       next_download: Timestamp;
     30 
     31       // Time when the current ``/keys`` response is expected to
     32       // expire. Missing if we do not have one.
     33       keys_expiration?: Timestamp;
     34 
     35       // HTTP status code returned by the exchange when we asked for
     36       // ``/keys``. 0 if we did not receive an HTTP status code.
     37       // Usually 200 for success.
     38       keys_http_status: Integer;
     39 
     40       // Numeric `error code <error-codes>` indicating an
     41       // error we had processing the ``/keys`` response.
     42       keys_ec: Integer;
     43 
     44       // Human-readable error description matching ``keys_ec``.
     45       keys_hint: string;
     46 
     47     }