From 56266998b6bd4f066b9d7f8d2a2fe85ac73ad2c4 Mon Sep 17 00:00:00 2001 From: MS Date: Tue, 15 Dec 2020 18:53:32 +0100 Subject: Nexus API for scheduling. Document how to submit a new task. --- libeufin/api-nexus.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'libeufin/api-nexus.rst') diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index 9bca39b4..ce93f8b1 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 -- cgit v1.2.3