summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorJonathan Buchanan <jonathan.russ.buchanan@gmail.com>2020-06-05 20:31:41 -0400
committerJonathan Buchanan <jonathan.russ.buchanan@gmail.com>2020-06-05 20:31:41 -0400
commita8a4774c1abec363cc7f178804ac56c558b069f0 (patch)
tree98d35eeed2402ca6f76ca292f0f9893e1b4042cf /core/api-merchant.rst
parentc028b2d151aaacb446035638379f565e8e5c30cd (diff)
downloaddocs-a8a4774c1abec363cc7f178804ac56c558b069f0.tar.gz
docs-a8a4774c1abec363cc7f178804ac56c558b069f0.tar.bz2
docs-a8a4774c1abec363cc7f178804ac56c558b069f0.zip
change GET /tips to GET /private/tips
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 3bde039d..03aefed7 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1957,14 +1957,17 @@ Giving Customer Tips
-.. http:get:: /tips
+.. http:get:: /private/tips
Return the list of all tips.
**Request:**
- :query expired: *Optional*. If set to "yes", the response also includes
- tips that have expired. Otherwise only unexpired tips are returned.
+ :query include_expired: *Optional*. If set to "yes", the result includes expired tips also. Otherwise, only active tips are returned.
+
+ :query limit: *Optional*. At most return the given number of results. Negative for descending in database row id, positive for ascending in database row id.
+
+ :query offset: *Optional*. Starting row_id for an iteration.
**Response:**
@@ -1984,17 +1987,14 @@ Giving Customer Tips
interface Tip {
+ // id of the tip in the backend database
+ row_id: number;
+
// Unique identifier for the tip.
tip_id: HashCode;
- // Exchange from which the tip will be withdrawn.
- exchange_url: string;
-
// (remaining) amount of the tip (including fees).
tip_amount: Amount;
-
- // Timestamp indicating when the tip is set to expire (may be in the past).
- expiration: Timestamp;
}