taler-docs

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

post-management-partners.rst (1966B)

      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     This response comes with a standard `ErrorDetail` response with
     17     a code of ``TALER_EC_EXCHANGE_MANAGEMENT_ADD_PARTNER_SIGNATURE_INVALID``.
     18   :http:statuscode:`409 Conflict`:
     19     The exchange has previously received a conflicting configuration message.
     20     This response comes with a standard `ErrorDetail` response with
     21     a code of ``TALER_EC_EXCHANGE_MANAGEMENT_ADD_PARTNER_DATA_CONFLICT``.
     22   :http:statuscode:`413 Request entity too large`:
     23     The uploaded body is to long, it exceeds the size limit.
     24     Returned with an error code of
     25     ``TALER_EC_GENERIC_UPLOAD_EXCEEDS_LIMIT``.
     26   :http:statuscode:`500 Internal Server Error`:
     27     The server experienced an internal error.
     28     This response comes with a standard `ErrorDetail` response with
     29     a code of ``TALER_EC_GENERIC_DB_STORE_FAILED``.
     30 
     31   **Details:**
     32 
     33   .. ts:def:: ExchangePartnerSetupRequest
     34 
     35     interface ExchangePartnerSetupRequest {
     36 
     37       // Base URL of the partner exchange
     38       partner_base_url: string;
     39 
     40       // Master (offline) public key of the partner exchange.
     41       partner_pub: EddsaPublicKey;
     42 
     43       // How frequently will wad transfers be made
     44       wad_frequency: RelativeTime;
     45 
     46       // Signature by the exchange master key over a
     47       // `TALER_PartnerConfigurationPS`.
     48       // Must have purpose ``TALER_SIGNATURE_MASTER_PARTNER_DETAILS``.
     49       master_sig: EddsaSignature;
     50 
     51       // When will the partner relationship start (inclusive).
     52       start_date: Timestamp;
     53 
     54       // When will the partner relationship end (exclusive).
     55       end_date: Timestamp;
     56 
     57       // Wad fee to be charged (to customers).
     58       wad_fee: Amount;
     59 
     60     }