taler-docs

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

post-management-partners.rst (1270B)

      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 
     19   **Details:**
     20 
     21   .. ts:def:: ExchangePartnerSetupRequest
     22 
     23     interface ExchangePartnerSetupRequest {
     24 
     25       // Base URL of the partner exchange
     26       partner_base_url: string;
     27 
     28       // Master (offline) public key of the partner exchange.
     29       partner_pub: EddsaPublicKey;
     30 
     31       // How frequently will wad transfers be made
     32       wad_frequency: RelativeTime;
     33 
     34       // Signature by the exchange master key over a
     35       // `TALER_PartnerConfigurationPS`.
     36       // Must have purpose ``TALER_SIGNATURE_MASTER_PARTNER_DETAILS``.
     37       master_sig: EddsaSignature;
     38 
     39       // When will the partner relationship start (inclusive).
     40       start_date: Timestamp;
     41 
     42       // When will the partner relationship end (exclusive).
     43       end_date: Timestamp;
     44 
     45       // Wad fee to be charged (to customers).
     46       wad_fee: Amount;
     47 
     48     }