diff options
Diffstat (limited to 'libeufin')
| -rw-r--r-- | libeufin/api-nexus.rst | 30 | ||||
| -rw-r--r-- | libeufin/concepts.rst | 18 |
2 files changed, 39 insertions, 9 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index eda8a796..ce93f8b1 100644 --- a/libeufin/api-nexus.rst +++ b/libeufin/api-nexus.rst @@ -162,6 +162,8 @@ manages payment initiations of the account and tracks the initiations of payment .. ts:def:: PaymentStatus interface PaymentStatus { + // Can be "BOOK" or "PDNG" ('pending'). + status: string; // Payment unique identifier paymentInitiationId: string; @@ -369,6 +371,34 @@ manages payment initiations of the account and tracks the initiations of payment } +.. http:post:: {nexusBase}/bank-accounts/{acctid}/schedule + + This endpoint allows the caller to define a recurrent + execution of a task. + + **Request** + + .. ts:def:: ScheduleTask + + interface ScheduleTask { + name: string; + + // a Unix-compatible cron pattern representing + // the frequency of execution of this task. + cronspec: string; + + // Can take values "fetch" (to download the history + // of the requester's bank account) or "submit" (to submit + // any initiated payment associated to the requester's + // bank account). + type: string; + + // Currently only used for "fetch" operations + params: { level: "REPORT" | "STATEMENT" | "ALL"}; + } + + + .. http:get:: {nexusBase}/bank-accounts/{acctid}/schedule/{taskId} This call returns the information related to the task associated diff --git a/libeufin/concepts.rst b/libeufin/concepts.rst index 0f52ed03..c3764344 100644 --- a/libeufin/concepts.rst +++ b/libeufin/concepts.rst @@ -47,14 +47,14 @@ for superusers. Only superusers are allowed to create/modify other users. Bank Accounts ------------- -A bank account is the local representation of some bank account. +A *bank account* is the local representation of some bank account. The information stored about it includes: * Local alias ("nickname") of the bank account * Account identification (IBAN / BIC / account holder) * A local mirror of the bank transaction history * Payment requests, i.e. payments that have been locally requested, together - with their state (sent or not sent, acknowledged in bank statement or not). + with their state (sent or not sent, acknowledged in bank statement or not) * Error reports (e.g. failed payment requests, bank statement items that were not understood by LibEuFin) * A default bank connection (if configured) that is used by default @@ -63,7 +63,7 @@ The information stored about it includes: Examples: -.. code:: none +.. code-block:: console # Download latest transactions via the default bank connection and store them locally curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-accounts/my-acct/fetch-transactions @@ -72,7 +72,7 @@ Bank Connections ---------------- Bank connections connect the local LibEuFin bank account to the real bank. -The bank connection includes the following data: +The *bank connection* includes the following data: * Local alias ("nickname") of the bank connection * The type of connection, i.e. the protocol used (EBICS, FinTS, loopback, sandbox) @@ -97,7 +97,7 @@ Bank connections provide the following actions: Examples: -.. code:: none +.. code-block:: console # Manually request the inter-day account report via the EBICS C52 order curl -XPOST $AUTHEADER https://example1.libeufin.tech/bank-connections/my-ebics-testacct/ebics/download/C52 @@ -111,7 +111,7 @@ Facades ------- Facades allow extra domain-specific functionality to be implemented on top of users, bank accounts -and bank connections. Facades store the following information: +and bank connections. A *facade* stores the following information: * Local name of the facade * Facade type and options specific to the type @@ -125,7 +125,7 @@ not conform to a certain format. Examples: -.. code:: none +.. code-block:: console # Request the Taler-specific history through the facade curl $AUTHEADER https://example1.libeufin.tech/facades/my-taler-wire-gw/taler/history/incoming @@ -133,7 +133,7 @@ Examples: Access Control ============== -The goal of access control in LibEuFin is to allow the following scenarios: +The goal of *access control* in LibEuFin is to allow the following scenarios: * The Nexus can be used by multiple clients for different bank accounts/connections and these users can't access each other's bank accounts @@ -150,7 +150,7 @@ Each top-level object (bank account, bank connection, facade) has a list of nexus users with write access, and a list of users with read access. When using a bank connection through a bank account, permission checks must -succeed for both the bank account and the bank connection +succeed for both the bank account and the bank connection. This works differently for facades: A facade has a set of associated bank connections and bank accounts it can access. Permissions on these associated objects |