get-private-accounts-H_WIRE.rst (2178B)
1 .. http:get:: [/instances/$INSTANCE]/private/accounts/$H_WIRE 2 3 This is used to obtain detailed information about a specific bank account. 4 5 6 **Required permission:** ``accounts-read`` 7 8 **Response:** 9 10 :http:statuscode:`200 OK`: 11 The backend has successfully returned the detailed information about a specific bank account. 12 Returns a `BankAccountDetail`. 13 :http:statuscode:`400 Bad Request`: 14 The ``$H_WIRE`` parameter is malformed. 15 Returned with ``TALER_EC_MERCHANT_GENERIC_H_WIRE_MALFORMED``. 16 :http:statuscode:`404 Not found`: 17 The bank account or instance is unknown to the backend. 18 Returned with ``TALER_EC_MERCHANT_GENERIC_ACCOUNT_UNKNOWN``. 19 :http:statuscode:`500 Internal Server Error`: 20 The server experienced an internal failure. 21 Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``. 22 23 **Details:** 24 25 .. ts:def:: BankAccountDetail 26 27 interface BankAccountDetail { 28 29 // Full payto:// URI of the account. 30 payto_uri: string; 31 32 // Hash over the wire details (including over the salt). 33 h_wire: HashCode; 34 35 // Salt used to compute h_wire. 36 salt: HashCode; 37 38 // URL from where the merchant can download information 39 // about incoming wire transfers to this account. 40 credit_facade_url?: string; 41 42 // true if this account is active, 43 // false if it is historic. 44 active: boolean; 45 46 // Additional text to include in the wire transfer subject when 47 // settling the payment. Note that the merchant MUST use this 48 // consistently for the same ``merchant_pub`` and ``merchant_payto_uri`` 49 // as during aggregation *any* of these values may be selected 50 // for the actual aggregated wire transfer. If a merchant wants 51 // to use different ``extra_subject`` values for the same IBAN, 52 // it should thus create multiple instances (with different 53 // ``merchant_pub`` values). When changing the ``extra_subject``, 54 // the change may thus not be immediately reflected in the 55 // settlements. 56 // 57 // Must match [a-zA-Z0-9-.:]{1, 40} 58 // 59 // Optional. Since **v27**. 60 extra_wire_subject_metadata?: string; 61 }