taler-docs

commit a58a34734f253382c3f8c346682a88a8e7ae2dae
parent 6aab1eb41f84f1f71aab49d39f6b364e8ded84e5
Author: MS <ms@taler.net>
Date:   Thu, 13 Apr 2023 19:45:56 +0200

Nexus API.

Make payment submission idempotent.

Diffstat:
M
libeufin/api-nexus.rst
 | 
18
++++++++++++++----

1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
@@ -47,7 +47,7 @@ User Management
 
   **Response:**
 
-  .. ts:def:: GetUserResponse
+  .. ts:def:: UserResponse
 
      interface UserResponse {
 
@@ -55,7 +55,7 @@ User Management
        username: string;
 
        // Is this a super user?
-       superuser: Boolean;
+       superuser: boolean;
      }
 
 .. http:post:: {nexusBase}/users/{userName}/password
@@ -323,7 +323,17 @@ tracks the initiations of payments.
        // payment subject.
        subject: string;
        // amount, in the format CURRENCY:XX.YY
-       amount: string
+       amount: string,
+
+       // This option lets the client associate a unique
+       // identifier to the payment being created.  This
+       // identifier will NOT be the identifier of the resource
+       // created by this request, therefore it won't be possible
+       // to _retrieve_ the resource by using this UID.
+       // This UID helps, for example, if the client wrongly submits
+       // the same request twice, because Nexus can make it idempotent
+       // and avoid financial loss.
+       uid?: string
      }
 
   **Response:**
@@ -354,7 +364,7 @@ tracks the initiations of payments.
          rangeType: string;
          // Bank connection to use.  Uses the default bank connection,
          // when not given.
-         bankConnection: string?;
+         bankConnection?: string;
      }
 
   **Response:**