summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-12-15 18:53:32 +0100
committerMS <ms@taler.net>2020-12-15 18:53:32 +0100
commit56266998b6bd4f066b9d7f8d2a2fe85ac73ad2c4 (patch)
tree1f4896da32ee2c2e44acb28a73e7b3236156379c /libeufin
parent47651cfb40b4027f5ae4e29be6ed0b4a18ded1cd (diff)
downloaddocs-56266998b6bd4f066b9d7f8d2a2fe85ac73ad2c4.tar.gz
docs-56266998b6bd4f066b9d7f8d2a2fe85ac73ad2c4.tar.bz2
docs-56266998b6bd4f066b9d7f8d2a2fe85ac73ad2c4.zip
Nexus API for scheduling.
Document how to submit a new task.
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-nexus.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 9bca39b..ce93f8b 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -371,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