taler-docs

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

post-management-wire-fee.rst (1572B)

      1 .. http:post:: /management/wire-fee
      2 
      3   This request is used to configure wire fees.
      4 
      5   **Request:**
      6 
      7   The request must be a `WireFeeSetupRequest`.
      8 
      9   **Response:**
     10 
     11   :http:statuscode:`204 No content`:
     12     The wire fee was successfully configured.
     13   :http:statuscode:`403 Forbidden`:
     14     The master signature is invalid. Returned with an error code
     15     of ``TALER_EC_EXCHANGE_MANAGEMENT_WIRE_FEE_SIGNATURE_INVALID``.
     16   :http:statuscode:`409 Conflict`:
     17     The exchange has a conflicting wire fee already set up.
     18     Returned with an errro code of
     19     ``TALER_EC_EXCHANGE_MANAGEMENT_WIRE_FEE_MISMATCH``.
     20   :http:statuscode:`500 Internal Server Error`:
     21     The server experienced an internal error.
     22     This response comes with a standard `ErrorDetail` response.
     23     Possible error codes include
     24     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` or
     25     ``TALER_EC_GENERIC_DB_STORE_FAILED``.
     26 
     27   **Details:**
     28 
     29   .. ts:def:: WireFeeSetupRequest
     30 
     31     interface WireFeeSetupRequest {
     32 
     33       // Wire method the fee applies to.
     34       wire_method: string;
     35 
     36       // Signature using the exchange's offline key
     37       // with purpose ``TALER_SIGNATURE_MASTER_WIRE_FEES``.
     38       master_sig: EddsaSignature;
     39 
     40       // When does the wire fee validity period start?
     41       fee_start: Timestamp;
     42 
     43       // When does the wire fee validity period end (exclusive).
     44       fee_end: Timestamp;
     45 
     46       // Closing fee to charge during that time period for this wire method.
     47       closing_fee: Amount;
     48 
     49       // Wire fee to charge during that time period for this wire method.
     50       wire_fee: Amount;
     51 
     52     }