diff options
Diffstat (limited to 'libeufin/api-sandbox.rst')
-rw-r--r-- | libeufin/api-sandbox.rst | 59 |
1 files changed, 57 insertions, 2 deletions
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst index d848ba40..d1214d52 100644 --- a/libeufin/api-sandbox.rst +++ b/libeufin/api-sandbox.rst @@ -9,28 +9,83 @@ HTTP API .. Payments. + +.. http:post:: /admin/payments/camt + + Return the history of one IBAN in Camt.053 format. + + **Request** + + .. code-block:: tsref + + interface CamtParams { + + // IBAN managed by the running Sandbox, for which + // the Camt.053 response is going to be generated. + iban: string; + + // The Camt type to return. Only '53' is allowed + // at this moment. + type: number; + } + + **Response** + + The expected Camt.053 document. + + +.. http:get:: /admin/payments + + Return the list of *all* the payments known by the sandbox. + + **Response** + + .. code-block:: tsref + + interface SandboxPayments { + + // The list of all known payments, regardless + // of any IBAN involved in them. + payments: SandboxPayment[]; + } + .. http:post:: /admin/payments Adds a new payment to the book. Mainly used for testing purposes. **Request:** + + One object of type `SandboxPayment` - .. ts:def:: PaymentRequest + .. ts:def:: SandboxPayment - interface PaymentRequest { + interface SandboxPayment { // IBAN that will receive the payment. creditorIban: string; + // FIXME + creditorBic: string; + // FIXME + creditorName: string; // IBAN that will send the payment. debitorIban: string; + // FIXME + debitorBic: string; + // FIXME + debitorName: string; amount: string; currency: string; // subject of the payment. subject: string; + + // Whether the payment is credit or debit *for* the + // account being managed *by* the running sandbox. + // Can take the values: "CRDT" or "DBIT". + direction: string; } .. |