summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2020-11-26 01:56:43 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2020-11-26 01:56:43 -0500
commit49517752ec1182d0e8540c93ddb0d79328c78006 (patch)
treea7a3fc7894a29a1f1dd8faec77da84d3cfd6ba56 /libeufin
parentdfbd26b57ba49f667a29ee43ccdf6b1e8cae6c09 (diff)
downloaddocs-49517752ec1182d0e8540c93ddb0d79328c78006.tar.gz
docs-49517752ec1182d0e8540c93ddb0d79328c78006.tar.bz2
docs-49517752ec1182d0e8540c93ddb0d79328c78006.zip
delete trailing whitespace; nfc
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-nexus.rst52
1 files changed, 26 insertions, 26 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 5f633a88..1e7b8a0e 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -110,17 +110,17 @@ The LibEuFin maintains a copy of the bank account transaction history and balanc
manages payment initiations of the account and tracks the initiations of payments.
.. http:get:: {nexusBase}/bank-accounts
-
+
**Response:**
A list of `BankAccount` objects
that belong to the requester.
.. ts:def:: BankAccount
-
+
interface BankAccount {
// mnemonic name identifying this bank account.
- nexusBankAccountId: string;
+ nexusBankAccountId: string;
// IBAN
iban: string;
// BIC
@@ -138,7 +138,7 @@ manages payment initiations of the account and tracks the initiations of payment
.. http:get:: {nexus}/bank-accounts/{my-acct}/payment-initiations/{uuid}
-
+
Ask the status of payment ``$uuid``.
**Response:**
@@ -185,14 +185,14 @@ manages payment initiations of the account and tracks the initiations of payment
.. ts:def:: InitiatedPayments
interface InitiatedPayments {
-
+
// list of all the initiated payments' UID.
initiatedPayments: PaymentStatus[];
}
.. http:post:: {nexusBase}/bank-accounts/{my-acct}/payment-initiations
-
+
Ask nexus to prepare instructions for a new payment.
Note that ``my-acct`` is the bank account that will be
**debited** after this operation.
@@ -208,7 +208,7 @@ manages payment initiations of the account and tracks the initiations of payment
bic: string;
// Legal subject that will receive the payment.
name: string;
- // payment subject.
+ // payment subject.
subject: string;
// amount, in the format CURRENCY:XX.YY
amount: string
@@ -217,7 +217,7 @@ manages payment initiations of the account and tracks the initiations of payment
**Response:**
.. ts:def:: PreparedPaymentResponse
-
+
interface PreparedPaymentResponse {
// Opaque identifier to be communicated when
@@ -318,7 +318,7 @@ Bank connections connect the local LibEuFin bank account
to the real bank.
.. http:post:: <nexus>/bank-connections
-
+
Activate a new bank connection for the requesting user.
**Request:**
@@ -331,18 +331,18 @@ to the real bank.
This type allows the creation of new bank accounts.
.. ts:def:: NewBankConnection
-
+
interface NewBankConnection {
-
+
source: string; // only "new" allowed
// connection name.
name: string;
// type of the connection to make: "ebics" for example.
- type: string;
+ type: string;
- data: BankConnectionNew;
+ data: BankConnectionNew;
}
This type allows to restore a previously made bank connection.
@@ -352,7 +352,7 @@ to the real bank.
interface BankConnectionRestoreRequest {
source: "backup";
-
+
// connection name.
name: string;
@@ -372,7 +372,7 @@ to the real bank.
// it will contain the required fields (as strings):
// 'ebicsURL', 'userID', 'partnerID', 'hostID', and
// the optional 'systemID'.
-
+
// Other connection types, like 'local' (used for testing
// purposes skipping any interaction with the bank service)
// and 'fints' are all work in progress!
@@ -381,7 +381,7 @@ to the real bank.
.. ts:def:: BankConnectionBackup
-
+
interface BankConnectionBackup {
// The information needed in this type depend entirely
@@ -398,7 +398,7 @@ to the real bank.
**Request:**
.. ts:def:: BankConnectionDeletion
-
+
interface BankConnectionDeletion {
// label of the bank connection to delete
bankConnectionId: string;
@@ -413,9 +413,9 @@ to the real bank.
.. ts:def:: BankConnection
interface BankConnection {
-
- // connection type. For example "ebics".
- type: string;
+
+ // connection type. For example "ebics".
+ type: string;
// connection name as given by the user at
// the moment of creation.
@@ -428,7 +428,7 @@ to the real bank.
Get information about one bank connection.
.. ts:def:: BankConnectionInfo
-
+
interface BankConnectionInfo {
bankConnectionId: string;
@@ -511,7 +511,7 @@ Facades
.. http:get:: <nexus>/facades
- List available facades.
+ List available facades.
.. http:post:: {nexus}/facades
@@ -522,7 +522,7 @@ Facades
Get details about a facade.
.. ts:def:: FacadeInfo
-
+
interface FacadeInfo {
// Name of the facade, same as the "fcid" parameter.
name: string;
@@ -566,7 +566,7 @@ Bank Connection Protocols
the full details for the connection yet.
.. ts:def:: EbicsHostTestRequest
-
+
interface EbicsHostTestRequest {
ebicsBaseUrl: string;
ebicsHostId: string;
@@ -595,7 +595,7 @@ They are namespaced under the ``/ebics/`` sub-resource.
.. warning::
Use with care. Typically only necessary for testing and debugging.
-
+
Perform an EBICS upload transaction of type ``msg``.
This request will not affect any bank account or other state
in the nexus database. It will just make a request to the bank
@@ -609,7 +609,7 @@ The ``taler-wire-gateway`` facade has the following configuration:
.. ts:def:: TalerWireGatewayFacadeConfig
-
+
interface TalerWireGatewayFacadeConfig {
// Bank account and connection that is
// abstracted over.