patch-private-accounts-H_WIRE.rst (2364B)
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`` or 18 ``TALER_EC_MERCHANT_GENERIC_H_WIRE_MALFORMED``. 19 :http:statuscode:`404 Not found`: 20 The account (``H_WIRE``) is unknown to the backend. 21 Returned with ``TALER_EC_MERCHANT_GENERIC_ACCOUNT_UNKNOWN``. 22 :http:statuscode:`500 Internal Server Error`: 23 The server experienced an internal failure. 24 Returned with ``TALER_EC_GENERIC_DB_STORE_FAILED`` or 25 ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE``. 26 27 **Details:** 28 29 .. ts:def:: AccountPatchDetails 30 31 interface AccountPatchDetails { 32 33 // URL from where the merchant can download information 34 // about incoming wire transfers to this account. 35 credit_facade_url?: string; 36 37 // Credentials to use when accessing the credit facade. 38 // Never returned on a GET (as this may be somewhat 39 // sensitive data). Can be set in POST 40 // or PATCH requests to update (or delete) credentials. 41 // To really delete credentials, set them to the type: "none". 42 // If the argument is omitted, the old credentials 43 // are simply preserved. 44 credit_facade_credentials?: FacadeCredentials; 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 }