taler-docs

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

convert-iban-account-field-to-payto.rst (1005B)

      1 .. ts:op:: convertIbanAccountFieldToPayto
      2   :read-only:
      3 
      4   Convert user input for a bank account number into an IBAN payto
      5   URI.
      6 
      7   **Request:**
      8 
      9     The request must be a `ConvertIbanAccountFieldToPaytoRequest`
     10     object.
     11 
     12   **Response:**
     13 
     14     On success, the result is a
     15     `ConvertIbanAccountFieldToPaytoResponse` object.
     16 
     17   **Details:**
     18 
     19     Dashes and spaces are stripped from the input.  For ``HUF``,
     20     the input is treated as a Hungarian BBAN and converted to an
     21     IBAN (a developer experiment enables the same conversion for
     22     Swiss BBANs); for other currencies, the input must be a valid
     23     IBAN.  When the input cannot be converted, ``ok`` is ``false``.
     24 
     25 .. ts:def:: ConvertIbanAccountFieldToPaytoRequest
     26 
     27   interface ConvertIbanAccountFieldToPaytoRequest {
     28     value: string;
     29     currency: string;
     30   }
     31 
     32 .. ts:def:: ConvertIbanAccountFieldToPaytoResponse
     33 
     34   type ConvertIbanAccountFieldToPaytoResponse =
     35     | { ok: true; type: "iban" | "bban"; paytoUri: string }
     36     | { ok: false };