diff options
-rw-r--r-- | taler-wallet.rst | 81 |
1 files changed, 70 insertions, 11 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst index 7d9bbd93..6fa493f8 100644 --- a/taler-wallet.rst +++ b/taler-wallet.rst @@ -607,17 +607,6 @@ A typical API sequence for *manual* withdrawals can for example look like this: #. ``"acceptManualWithdrawal"`` after the user confirmed withdrawal with associated fees -Withdraw balance from test environment -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:Name: ``"withdrawTestkudos"`` -:Description: - Withdraw a balance from the test environment. -:Request: - The request parameters are ignored. -:Response: - On success, the response is an empty object. - Get Details For Bank-integrated Withdrawal ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -832,6 +821,76 @@ Confirm Payment | ConfirmPayResultDone; | ConfirmPayResultPending; +Testing API calls +----------------- + +The following API calls are useful for testing. + +Withdraw balance from the TESTKUDOS environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:Name: ``"withdrawTestkudos"`` +:Description: + Withdraw a balance from the ``TESTKUDOS`` environment. +:Request: + The request parameters are ignored. +:Response: + On success, the response is an empty object. + +Withdraw balance from a test environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:Name: ``"withdrawTestBalance"`` +:Description: + Withdraw a balance from a test environment. +:Request: + .. ts:def:: WithdrawTestBalanceRequest + + interface WithdrawTestBalanceRequest { + amount: string; + bankBaseUrl: string; + exchangeBaseUrl: string; + } +:Response: + On success, the response is an empty object. + +Run integration test +~~~~~~~~~~~~~~~~~~~~ + +:Name: ``"runIntegrationTest"`` +:Description: + Run a basic integration test that does a withdrawal, payment, + refund and again a payment. Useful to generate test data + in the integration tests of other components. +:Request: + .. ts:def:: IntegrationTestArgs + + interface IntegrationTestArgs { + exchangeBaseUrl: string; + bankBaseUrl: string; + merchantBaseUrl: string; + merchantApiKey: string; + amountToWithdraw: string; + amountToSpend: string; + } +:Response: + On success, the response is an empty object. + +Make a test payment +~~~~~~~~~~~~~~~~~~~ + +:Name: ``"testPay"`` +:Description: + Make a test payment with existing funds. +:Request: + .. ts:def:: TestPayArgs + + interface TestPayArgs { + merchantBaseUrl: string; + merchantApiKey: string; + amount: string; + summary: string; + } Global Errors ------------- |