[taler-docs] branch master updated: spec preparePay

[gnunet]

This is an automated email from the git hooks/post-receive script.

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new d238b21  spec preparePay
d238b21 is described below

commit d238b215e5de5c929c0b128a74ab229afd7dfa81
Author: Florian Dold <florian.dold@gmail.com>
AuthorDate: Tue Jul 28 15:16:00 2020 +0530

    spec preparePay
---
 taler-wallet.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/taler-wallet.rst b/taler-wallet.rst
index 0889224..12fee3c 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -649,6 +649,51 @@ Prepare Pay
 :Name: ``"preparePay"``
 :Description:
   Fetch information about a payment request from a merchant.
+:Request:
+  .. ts:def:: PreparePayRequest
+
+    interface PreparePayRequest {
+      talerPayUri: string;
+    }
+:Response:
+  .. ts:def:: PreparePayResponse
+
+  type PreparePayResponse =
+    | PreparePayPaymentPossibleResponse
+    | PreparePayAlreadyConfirmedResponse
+    | PreparePayInsufficientBalanceResponse;
+
+  interface PreparePayPaymentPossibleResponse {
+    status: "payment-possible";
+
+    proposalId: string;
+
+    // Verbatim contract terms as generated by the merchant.
+    contractTermsRaw: any;
+  }
+
+  interface PreparePayInsufficientBalanceResponse {
+    status: "insufficient-balance";
+
+    proposalId: string;
+
+    // Verbatim contract terms as generated by the merchant.
+    contractTermsRaw: any;
+  }
+
+  interface PreparePayAlreadyConfirmedResponse {
+    status: "already-confirmed";
+
+    proposalId: string;
+
+    // Did the payment succeed?
+    paid: boolean;
+
+    // Redirect URL for the fulfillment page,
+    // only given if paid==true.
+    nextUrl?: string;
+  }
+
 
 Confirm Payment
 ~~~~~~~~~~~~~~~

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.