taler-docs

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

get-banking-choices-for-payto.rst (1021B)

      1 .. ts:op:: getBankingChoicesForPayto
      2   :read-only:
      3 
      4   Get banking applications or websites that can execute the given
      5   payto URI.
      6 
      7   **Request:**
      8 
      9     The request must be a `GetBankingChoicesForPaytoRequest`
     10     object.
     11 
     12   **Response:**
     13 
     14     On success, the result is a `GetBankingChoicesForPaytoResponse`
     15     object.
     16 
     17   **Details:**
     18 
     19     Currently, choices are only returned for the ``KUDOS``
     20     demonstration currency (links to the demonstrator bank's
     21     website and app); the list is empty when the payto URI carries
     22     no amount or no choice is known for the currency.  An error is
     23     thrown when ``paytoUri`` is not a valid payto URI.
     24 
     25 .. ts:def:: GetBankingChoicesForPaytoRequest
     26 
     27   interface GetBankingChoicesForPaytoRequest {
     28     paytoUri: string;
     29   }
     30 
     31 .. ts:def:: GetBankingChoicesForPaytoResponse
     32 
     33   interface GetBankingChoicesForPaytoResponse {
     34     choices: BankingChoiceSpec[];
     35   }
     36 
     37 .. ts:def:: BankingChoiceSpec
     38 
     39   interface BankingChoiceSpec {
     40     label: string;
     41     type: "link";
     42     uri: string;
     43   }