summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-08-07 13:59:55 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-08-07 13:59:55 +0530
commit75c5d7e9fa43319ca8636aa03cacd88b01ed837b (patch)
treec18376140a2f0ba4f2d8773c554cd3bcaf1a8d6e /taler-wallet.rst
parent5a40f637fed3ed087e7d723bd04ed766e3b651e7 (diff)
downloaddocs-75c5d7e9fa43319ca8636aa03cacd88b01ed837b.tar.gz
docs-75c5d7e9fa43319ca8636aa03cacd88b01ed837b.tar.bz2
docs-75c5d7e9fa43319ca8636aa03cacd88b01ed837b.zip
wallet api
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst35
1 files changed, 33 insertions, 2 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index ae0656d..0b44b61 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -733,6 +733,8 @@ Prepare Pay
| PreparePayAlreadyConfirmedResponse
| PreparePayInsufficientBalanceResponse;
+ .. ts:def:: PreparePayPaymentPossibleResponse
+
interface PreparePayPaymentPossibleResponse {
status: "payment-possible";
@@ -749,15 +751,22 @@ Prepare Pay
amountEffective: Amount;
}
+ .. ts:def:: PreparePayInsufficientBalanceResponse
+
interface PreparePayInsufficientBalanceResponse {
status: "insufficient-balance";
proposalId: string;
+ // Amount that the merchant is asking for.
+ amountRaw: Amount;
+
// Verbatim contract terms as generated by the merchant.
contractTerms: ContractTerms;
}
+ .. ts:def:: PreparePayAlreadyConfirmedResponse
+
interface PreparePayAlreadyConfirmedResponse {
status: "already-confirmed";
@@ -766,6 +775,9 @@ Prepare Pay
// Did the payment succeed?
paid: boolean;
+ // Amount that the merchant is asking for.
+ amountRaw: Amount;
+
// Redirect URL for the fulfillment page,
// only given if paid==true.
nextUrl?: string;
@@ -778,6 +790,7 @@ Confirm Payment
:Name: ``"confirmPay"``
:Description:
Confirm making a payment.
+
:Request:
.. ts:def:: GetManualWithdrawalDetailsRequest
@@ -785,14 +798,32 @@ Confirm Payment
proposalId: string;
}
:Response:
- .. ts:def:: ConfirmPayResult
+ .. ts:def:: ConfirmPayResultDone
+
+ interface ConfirmPayResultDone {
+ type: "done";
- interface ConfirmPayResult {
// Fulfillment URL augmented with order ID
// or a special taler://fulfillment-success URL
nextUrl: string;
}
+ .. ts:def:: ConfirmPayResultPending
+
+ // Payment was marked as confirmed,
+ // but the attempt(s) to pay were not successful yet.
+ interface ConfirmPayPending {
+ type: "pending";
+
+ lastError: TransactionError;
+ }
+
+ .. ts:def:: ConfirmPayResult
+
+ type ConfirmPayResult =
+ | ConfirmPayResultDone;
+ | ConfirmPayResultPending;
+
Global Errors
-------------