aboutsummaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-04-23 20:23:58 +0200
committerChristian Grothoff <christian@grothoff.org>2023-04-23 20:23:58 +0200
commitdba2b83e01b9d64e5567507c7d48b63054d3a91a (patch)
treed39f21ceb664fd4c8a4c75143ccd393c39d4432a /core/api-merchant.rst
parent31e5e0753daccc69fccb5ae0b353969f838e0b60 (diff)
downloaddocs-dba2b83e01b9d64e5567507c7d48b63054d3a91a.tar.gz
docs-dba2b83e01b9d64e5567507c7d48b63054d3a91a.tar.bz2
docs-dba2b83e01b9d64e5567507c7d48b63054d3a91a.zip
breaking API change for #6363
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst26
1 files changed, 21 insertions, 5 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index d53df4ff..2f0ea5d5 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -897,13 +897,13 @@ Setting up instances
.. ts:def:: InstanceConfigurationMessage
interface InstanceConfigurationMessage {
- // The URI where the wallet will send coins. A merchant may have
+ // Bank accounts of the merchant. A merchant may have
// multiple accounts, thus this is an array. Note that by
- // removing URIs from this list the respective account is set to
+ // removing accounts from this list the respective account is set to
// inactive and thus unavailable for new contracts, but preserved
// in the database as existing offers and contracts may still refer
// to it.
- payto_uris: string[];
+ accounts: MerchantBankAccount[];
// Name of the merchant instance to create (will become $INSTANCE).
// Must match the regex ``^[A-Za-z0-9][A-Za-z0-9_.@-]+$``.
@@ -960,6 +960,22 @@ Setting up instances
}
+ .. ts:def:: MerchantBankAccount
+
+ interface MerchantBankAccount
+ // The payto:// URI where the wallet will send coins.
+ payto_uri: string;
+
+ // Optional base URL for a facade where the
+ // merchant backend can see incoming wire
+ // transfers to reconcile its accounting
+ // with that of the exchange. Used by
+ // taler-merchant-wirewatch.
+ credit_facade_url?: string;
+
+ // Credentials for accessing the credit facade.
+ credit_facade_credentials?: FacadeCredentials;
+ }
.. http:post:: /management/instances/$INSTANCE/auth
.. http:post:: [/instances/$INSTANCE]/private/auth
@@ -1021,11 +1037,11 @@ Setting up instances
.. ts:def:: InstanceReconfigurationMessage
interface InstanceReconfigurationMessage {
- // The URI where the wallet will send coins. A merchant may have
+ // Bank accounts of the merchant. A merchant may have
// multiple accounts, thus this is an array. Note that removing
// URIs from this list deactivates the specified accounts
// (they will no longer be used for future contracts).
- payto_uris: string[];
+ accounts: MerchantBankAccount[];
// Merchant name corresponding to this instance.
name: string;