taler-docs

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

get-qr-codes-for-payto.rst (1231B)

      1 .. ts:op:: getQrCodesForPayto
      2   :read-only:
      3   :deprecated:
      4 
      5   This operation is **deprecated**.  Consult the withdrawal
      6   transaction details instead.
      7 
      8   Get QR code representations of a payto URI, for example to let
      9   the user scan the code with a banking app.
     10 
     11   **Request:**
     12 
     13     The request must be a `GetQrCodesForPaytoRequest` object.
     14 
     15   **Response:**
     16 
     17     On success, the result is a `GetQrCodesForPaytoResponse`
     18     object.
     19 
     20   **Details:**
     21 
     22     All applicable QR code specifications are returned (an EPC QR
     23     code and/or a Swiss QR bill); the list is empty when none
     24     applies to the given payto URI.
     25 
     26 .. ts:def:: GetQrCodesForPaytoRequest
     27 
     28   interface GetQrCodesForPaytoRequest {
     29     paytoUri: string;
     30   }
     31 
     32 .. ts:def:: GetQrCodesForPaytoResponse
     33 
     34   interface GetQrCodesForPaytoResponse {
     35     codes: QrCodeSpec[];
     36   }
     37 
     38 .. ts:def:: QrCodeSpec
     39 
     40   // Specification of a QR code that includes payment information.
     41   interface QrCodeSpec {
     42     // Type of the QR code.  Depending on the type, different
     43     // visual styles might be applied.
     44     type: SupportedBankQr;
     45 
     46     // Content of the QR code that should be rendered.
     47     qrContent: string;
     48   }
     49 
     50 .. ts:def:: SupportedBankQr
     51 
     52   type SupportedBankQr = "epc-qr" | "spc";