taler-docs

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

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

      1 .. ts:op:: convertIbanPaytoToAccountField
      2   :read-only:
      3 
      4   Convert an IBAN payto URI into the account number representation
      5   expected by the target country's banking interfaces.
      6 
      7   **Request:**
      8 
      9     The request must be a `ConvertIbanPaytoToAccountFieldRequest`
     10     object.
     11 
     12   **Response:**
     13 
     14     On success, the result is a
     15     `ConvertIbanPaytoToAccountFieldResponse` object.
     16 
     17   **Details:**
     18 
     19     Hungarian IBANs are converted to the domestic BBAN form (a
     20     developer experiment enables the same conversion for Swiss
     21     IBANs); all other IBANs are returned unchanged.  An error is
     22     thrown when ``paytoUri`` is not a valid payto URI.
     23 
     24 .. ts:def:: ConvertIbanPaytoToAccountFieldRequest
     25 
     26   interface ConvertIbanPaytoToAccountFieldRequest {
     27     paytoUri: string;
     28   }
     29 
     30 .. ts:def:: ConvertIbanPaytoToAccountFieldResponse
     31 
     32   interface ConvertIbanPaytoToAccountFieldResponse {
     33     type: "iban" | "bban";
     34     value: string;
     35   }