summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-07-28 15:16:00 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-07-28 15:20:25 +0530
commitd238b215e5de5c929c0b128a74ab229afd7dfa81 (patch)
tree9e250a3d9f5c0ab56bf0ed45b7a3cac434b2250f /taler-wallet.rst
parent2dfd33c97043fffa9f581dafac5d002325c179b5 (diff)
downloaddocs-d238b215e5de5c929c0b128a74ab229afd7dfa81.tar.gz
docs-d238b215e5de5c929c0b128a74ab229afd7dfa81.tar.bz2
docs-d238b215e5de5c929c0b128a74ab229afd7dfa81.zip
spec preparePay
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst45
1 files changed, 45 insertions, 0 deletions
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
~~~~~~~~~~~~~~~