taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit be6eb544fdedc716cfe5d0643932499191d38b19
parent 76aca030d385c1f59824a0bc34af9c5a512ca2f0
Author: MS <ms@taler.net>
Date:   Thu,  9 Feb 2023 15:57:35 +0100

circuit API

allow to filter on usernames when
asking the list of cash-out operations.

Diffstat:
Mlibeufin/api-sandbox.rst | 19++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst @@ -442,6 +442,15 @@ Cashouts .. http:get:: /cashouts Returns the list of all the (pending and confirmed) cash-out operations. + Ordinary users can only use this endpoint to learn their *own* cash-out + operations. + + **Request:** + + :query account: *Optional.* + Filters the request to only get the cash-out operations related to + the account specified in this parameter. Ordinary users must use + this option and pass their own username as the value. **Response:** @@ -452,12 +461,16 @@ Cashouts cashouts: string[]; } - :http:statuscode:`204 No Content`: - No cash-out operations were found at the bank - :http:statuscode:`200 OK`: At least one cash-out operation was found. + :http:statuscode:`204 No Content`: + No cash-out operations were found at the bank + + :http:statuscode:`403 Forbidden`: + A ordinary user invoked this call either without + the ``account`` parameter or by passing to it someone + else's username. .. http:get:: /cashouts/$cashoutId