patch-private-accounts-H_WIRE.rst (1880B)
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:`404 Not found`: 16 The account (``H_WIRE``) is unknown to the backend. 17 18 **Details:** 19 20 .. ts:def:: AccountPatchDetails 21 22 interface AccountPatchDetails { 23 24 // URL from where the merchant can download information 25 // about incoming wire transfers to this account. 26 credit_facade_url?: string; 27 28 // Credentials to use when accessing the credit facade. 29 // Never returned on a GET (as this may be somewhat 30 // sensitive data). Can be set in POST 31 // or PATCH requests to update (or delete) credentials. 32 // To really delete credentials, set them to the type: "none". 33 // If the argument is omitted, the old credentials 34 // are simply preserved. 35 credit_facade_credentials?: FacadeCredentials; 36 37 // Additional text to include in the wire transfer subject when 38 // settling the payment. Note that the merchant MUST use this 39 // consistently for the same ``merchant_pub`` and ``merchant_payto_uri`` 40 // as during aggregation *any* of these values may be selected 41 // for the actual aggregated wire transfer. If a merchant wants 42 // to use different ``extra_subject`` values for the same IBAN, 43 // it should thus create multiple instances (with different 44 // ``merchant_pub`` values). When changing the ``extra_subject``, 45 // the change may thus not be immediately reflected in the 46 // settlements. 47 // 48 // Must match [a-zA-Z0-9-.:]{1, 40} 49 // 50 // Optional. Since **v27**. 51 extra_wire_subject_metadata?: string; 52 }