taler-docs

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

post-management-partners.rst (1464B)

      1 
      2 .. http:post:: /management/partners
      3 
      4   Enables a partner exchange for wad transfers.
      5 
      6   **Request:**
      7 
      8   The request must be an `ExchangePartnerSetupRequest` message.
      9 
     10   **Response:**
     11 
     12   :http:statuscode:`204 No content`:
     13     The partner has been added successfully.
     14   :http:statuscode:`403 Forbidden`:
     15     The signature is invalid.
     16   :http:statuscode:`409 Conflict`:
     17     The exchange has previously received a conflicting configuration message.
     18   :http:statuscode:`413 Request entity too large`:
     19     The uploaded body is to long, it exceeds the size limit.
     20     Returned with an error code of
     21     ``TALER_EC_GENERIC_UPLOAD_EXCEEDS_LIMIT``.
     22 
     23   **Details:**
     24 
     25   .. ts:def:: ExchangePartnerSetupRequest
     26 
     27     interface ExchangePartnerSetupRequest {
     28 
     29       // Base URL of the partner exchange
     30       partner_base_url: string;
     31 
     32       // Master (offline) public key of the partner exchange.
     33       partner_pub: EddsaPublicKey;
     34 
     35       // How frequently will wad transfers be made
     36       wad_frequency: RelativeTime;
     37 
     38       // Signature by the exchange master key over a
     39       // `TALER_PartnerConfigurationPS`.
     40       // Must have purpose ``TALER_SIGNATURE_MASTER_PARTNER_DETAILS``.
     41       master_sig: EddsaSignature;
     42 
     43       // When will the partner relationship start (inclusive).
     44       start_date: Timestamp;
     45 
     46       // When will the partner relationship end (exclusive).
     47       end_date: Timestamp;
     48 
     49       // Wad fee to be charged (to customers).
     50       wad_fee: Amount;
     51 
     52     }