get-private-accounts-H_WIRE.rst (1813B)
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:`404 Not found`: 14 The bank account or instance is unknown to the backend. 15 16 **Details:** 17 18 .. ts:def:: BankAccountDetail 19 20 interface BankAccountDetail { 21 22 // Full payto:// URI of the account. 23 payto_uri: string; 24 25 // Hash over the wire details (including over the salt). 26 h_wire: HashCode; 27 28 // Salt used to compute h_wire. 29 salt: HashCode; 30 31 // URL from where the merchant can download information 32 // about incoming wire transfers to this account. 33 credit_facade_url?: string; 34 35 // true if this account is active, 36 // false if it is historic. 37 active: boolean; 38 39 // Additional text to include in the wire transfer subject when 40 // settling the payment. Note that the merchant MUST use this 41 // consistently for the same ``merchant_pub`` and ``merchant_payto_uri`` 42 // as during aggregation *any* of these values may be selected 43 // for the actual aggregated wire transfer. If a merchant wants 44 // to use different ``extra_subject`` values for the same IBAN, 45 // it should thus create multiple instances (with different 46 // ``merchant_pub`` values). When changing the ``extra_subject``, 47 // the change may thus not be immediately reflected in the 48 // settlements. 49 // 50 // Must match [a-zA-Z0-9-.:]{1, 40} 51 // 52 // Optional. Since **v27**. 53 extra_wire_subject_metadata?: string; 54 }