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