patch-private-accounts-H_WIRE.rst (2190B)
1 .. http:patch:: [/instances/$INSTANCE]/private/accounts/$H_WIRE 2 3 This is used to update a bank account. 4 5 **Required permission:** ``accounts-write`` 6 7 **Request:** 8 9 The request must be a `AccountPatchDetails`. 10 11 **Response:** 12 13 :http:statuscode:`204 No content`: 14 The account has successfully modified. 15 :http:statuscode:`400 Bad Request`: 16 The ``$H_WIRE`` parameter or request body is malformed. 17 Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``. 18 :http:statuscode:`404 Not found`: 19 The account (``H_WIRE``) is unknown to the backend. 20 :http:statuscode:`500 Internal Server Error`: 21 The server experienced an internal failure. 22 Returned with ``TALER_EC_GENERIC_DB_STORE_FAILED``. 23 24 **Details:** 25 26 .. ts:def:: AccountPatchDetails 27 28 interface AccountPatchDetails { 29 30 // URL from where the merchant can download information 31 // about incoming wire transfers to this account. 32 credit_facade_url?: string; 33 34 // Credentials to use when accessing the credit facade. 35 // Never returned on a GET (as this may be somewhat 36 // sensitive data). Can be set in POST 37 // or PATCH requests to update (or delete) credentials. 38 // To really delete credentials, set them to the type: "none". 39 // If the argument is omitted, the old credentials 40 // are simply preserved. 41 credit_facade_credentials?: FacadeCredentials; 42 43 // Additional text to include in the wire transfer subject when 44 // settling the payment. Note that the merchant MUST use this 45 // consistently for the same ``merchant_pub`` and ``merchant_payto_uri`` 46 // as during aggregation *any* of these values may be selected 47 // for the actual aggregated wire transfer. If a merchant wants 48 // to use different ``extra_subject`` values for the same IBAN, 49 // it should thus create multiple instances (with different 50 // ``merchant_pub`` values). When changing the ``extra_subject``, 51 // the change may thus not be immediately reflected in the 52 // settlements. 53 // 54 // Must match [a-zA-Z0-9-.:]{1, 40} 55 // 56 // Optional. Since **v27**. 57 extra_wire_subject_metadata?: string; 58 }