commit 2932c14c4d3d648205f6e26bf1b645061f5576d3
parent e77c293531b7b065f1b24872cb8cadd0904d3186
Author: bohdan-potuzhnyi <bohdan.potuzhnyi@gmail.com>
Date: Mon, 26 Jan 2026 01:04:19 +0100
adding tips to the order contract #0010889
Diffstat:
1 file changed, 20 insertions(+), 3 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -4165,10 +4165,15 @@ Creating orders
// Optional, defaults to 0 if not set.
version?: 0;
- // Total price for the transaction. The exchange will subtract deposit
- // fees from that amount before transferring it to the merchant.
+ // Total price for the transaction, including tip. The exchange will
+ // subtract deposit fees from that amount before transferring it to
+ // the merchant.
amount: Amount;
+ // Optional tip amount. Must match the currency of ``amount``.
+ // Since protocol **v25**.
+ tip?: Amount;
+
// Maximum total deposit fee accepted by the merchant for this contract.
// Overrides defaults of the merchant instance.
max_fee?: Amount;
@@ -4289,6 +4294,10 @@ Creating orders
// fees from that amount before transferring it to the merchant.
amount: Amount;
+ // Optional tip amount. Must match the currency of ``amount``.
+ // Since protocol **v25**.
+ tip?: Amount;
+
// Human readable description of the semantics of the choice
// within the contract to be shown to the user at payment.
description?: string;
@@ -7239,11 +7248,15 @@ The contract terms must have the following structure:
// Defaults to version 0.
version?: 0;
- // Total price for the transaction.
+ // Total price for the transaction, including tip.
// The exchange will subtract deposit fees from that amount
// before transferring it to the merchant.
amount: Amount;
+ // Optional tip amount. Must match the currency of ``amount``.
+ // Since protocol **v25**.
+ tip?: Amount;
+
// Maximum total deposit fee accepted by the merchant for this contract.
// Overrides defaults of the merchant instance.
max_fee: Amount;
@@ -7405,6 +7418,10 @@ The contract terms must have the following structure:
// before transferring it to the merchant.
amount: Amount;
+ // Optional tip amount. Must match the currency of ``amount``.
+ // Since protocol **v25**.
+ tip?: Amount;
+
// Human readable description of the semantics of the choice
// within the contract to be shown to the user at payment.
description?: string;