diff options
| author | Christian Grothoff <christian@grothoff.org> | 2023-04-15 22:32:35 +0200 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2023-04-15 22:32:35 +0200 |
| commit | 2bd9fd051384d842a5215c93feaa69ec12ffe1b2 (patch) | |
| tree | 9ad8ee6f667862a8dfc3a791ebcc731576397611 /core/api-merchant.rst | |
| parent | 59cd3450714361b392662118e2a29df92c472b09 (diff) | |
| download | docs-2bd9fd051384d842a5215c93feaa69ec12ffe1b2.tar.gz docs-2bd9fd051384d842a5215c93feaa69ec12ffe1b2.tar.bz2 docs-2bd9fd051384d842a5215c93feaa69ec12ffe1b2.zip | |
document long-polling API for tip pickup notification
Diffstat (limited to 'core/api-merchant.rst')
| -rw-r--r-- | core/api-merchant.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index 8cbdbe9b..53a0f65e 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -2921,7 +2921,12 @@ Checking tip status **Request:** - :query pickups: If set to "yes", returns also information about all of the pickups. + :query pickups: *Optional*. If set to "yes", returns also information about all of the pickups. + :query min_amount: *Optional*. Minimum pick-up amount the client is interested in. + :query timeout_ms=NUMBER: *Optional.* If specified, the merchant backend will + wait up to ``timeout_ms`` milliseconds for tips of at least min_pick_up to be + picked up. A client must never rely on this behavior, as the + merchant backend may return a response immediately. **Response:** |