summaryrefslogtreecommitdiff
path: root/core/api-bank-integration.rst
diff options
context:
space:
mode:
authorAntoine A <>2023-11-13 23:09:27 +0000
committerAntoine A <>2023-11-13 23:09:27 +0000
commit48d2a70f4b062bf0a6d58df32f07b81e45d2b00e (patch)
tree0634393b8e7cad4ea869ff3b35ae991acb73f63e /core/api-bank-integration.rst
parent73ba612584aedd36a7d59089835aeb005583b993 (diff)
downloaddocs-48d2a70f4b062bf0a6d58df32f07b81e45d2b00e.tar.gz
docs-48d2a70f4b062bf0a6d58df32f07b81e45d2b00e.tar.bz2
docs-48d2a70f4b062bf0a6d58df32f07b81e45d2b00e.zip
harmonise style
Diffstat (limited to 'core/api-bank-integration.rst')
-rw-r--r--core/api-bank-integration.rst12
1 files changed, 5 insertions, 7 deletions
diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst
index 4a9650dc..d5fab1ca 100644
--- a/core/api-bank-integration.rst
+++ b/core/api-bank-integration.rst
@@ -64,11 +64,11 @@ Withdrawing
Withdrawals with a Taler-integrated bank are based on withdrawal operations.
Some user interaction (on the bank's website or a Taler-enabled ATM) creates a
withdrawal operation record in the bank's database. The wallet can use a unique identifier
-for the withdrawal operation (the ``wopid``) to interact with the withdrawal operation.
+for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdrawal operation.
-.. http:get:: ${BANK_API_BASE_URL}/withdrawal-operation/${wopid}
+.. http:get:: /withdrawal-operation/$WITHDRAWAL_ID
- Query information about a withdrawal operation, identified by the ``wopid``.
+ Query information about a withdrawal operation, identified by the ``WITHDRAWAL_ID``.
**Request:**
@@ -123,14 +123,13 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope
wire_types: string[];
}
-.. http:post:: ${BANK_API_BASE_URL}/withdrawal-operation/${wopid}
+.. http:post:: /withdrawal-operation/$WITHDRAWAL_ID
**Request:**
.. ts:def:: BankWithdrawalOperationPostRequest
interface BankWithdrawalOperationPostRequest {
-
// Reserve public key.
reserve_pub: string;
@@ -144,7 +143,7 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope
The bank has accepted the withdrawal operation parameters chosen by the wallet.
The response is a `BankWithdrawalOperationPostResponse`.
:http:statuscode:`404 Not found`:
- The bank does not know about a withdrawal operation with the specified ``wopid``.
+ The bank does not know about a withdrawal operation with the specified ``WITHDRAWAL_ID``.
:http:statuscode:`409 Conflict`:
* ``TALER_EC_BANK_WITHDRAWAL_OPERATION_RESERVE_SELECTION_CONFLICT`` :
The wallet selected a different exchange or reserve public key under the same withdrawal ID.
@@ -157,7 +156,6 @@ for the withdrawal operation (the ``wopid``) to interact with the withdrawal ope
.. ts:def:: BankWithdrawalOperationPostResponse
interface BankWithdrawalOperationPostResponse {
-
// The transfer has been confirmed and registered by the bank.
// Does not guarantee that the funds have arrived at the exchange already.
transfer_done: boolean;