diff options
| author | Christian Grothoff <christian@grothoff.org> | 2020-05-10 19:57:16 +0200 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2020-05-10 19:57:16 +0200 |
| commit | 04b2105c352a974d4559df3e3372583d1ab59686 (patch) | |
| tree | 73e548bebb326ef8341b3355121c5822a293580b /core/api-merchant.rst | |
| parent | 864be019f75faad33b76c534459498c5eede7b83 (diff) | |
| download | docs-04b2105c352a974d4559df3e3372583d1ab59686.tar.gz docs-04b2105c352a974d4559df3e3372583d1ab59686.tar.bz2 docs-04b2105c352a974d4559df3e3372583d1ab59686.zip | |
clarify filter
Diffstat (limited to 'core/api-merchant.rst')
| -rw-r--r-- | core/api-merchant.rst | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst index db6da6df..d1563da1 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1529,21 +1529,28 @@ Tracking Wire Transfers .. http:get:: /private/transfers - Obtain a list of all wire transfers the backend has checked. + Obtain a list of all wire transfers the backend has checked. Note that when + filtering by timestamp (using "before" and/or "after"), we use the time + reported by the exchange and thus will ONLY return results for which we already + have a response from the exchange. This should be virtually all transfers, however + it is conceivable that for some transfer the exchange responded with a temporary + error (i.e. HTTP status 500+) and then we do not yet have an execution time to + filter by. Thus, IF timestamp filters are given, transfers for which we have no + response from the exchange yet are automatically excluded. **Request:** - :query payto_uri: *Optional*. Filter for transfers to the given bank account (subject and amount MUST NOT be given in the payto URI) + :query payto_uri: *Optional*. Filter for transfers to the given bank account (subject and amount MUST NOT be given in the payto URI) - :query before: *Optional*. Filter for transfers executed before the given timestamp + :query before: *Optional*. Filter for transfers executed before the given timestamp - :query after: *Optional*. Filter for transfers executed after the given timestamp + :query after: *Optional*. Filter for transfers executed after the given timestamp - :query limit: *Optional*. At most return the given number of results. Negative for descending in execution time, positive for ascending in execution time. + :query limit: *Optional*. At most return the given number of results. Negative for descending in execution time, positive for ascending in execution time. - :query offset: *Optional*. Starting transfer_serial_id for an iteration. + :query offset: *Optional*. Starting transfer_serial_id for an iteration. - :query verified: *Optional*. Filter transfers by verification status. + :query verified: *Optional*. Filter transfers by verification status. **Response:** |