Taler EbiSync API

1.14. Taler EbiSync API#

1.14.1. Version History#

The current protocol version is v0.

1.14.2. Introduction#

LibEuFin EbiSync API.

1.14.3. Config#

GET /config#

Return the protocol version and configuration information about the bank. This specification corresponds to current protocol being version v11.

Response:

200 OK:

Response is a Config.

Details:

interface Config {
  // Name of the API.
  name: "taler-ebisync";

  // libtool-style representation of the Bank protocol version, see
  // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
  // The format is "current:revision:age".
  version: string;

  // SPA display version to be used in user interfaces.
  spa_version: string;
}

1.14.4. Web UI#

The web UI served under /.

1.14.5. Submit#

GET /submit#

Obtains a list of the orders that can be used.

Response:

200 OK:

The server responds with a ListSubmitOrders object.

401 Unauthorized:

Invalid or missing credentials.

403 Forbidden:

Missing rights.

Details:

interface ListSubmitOrders {
  orders: SubmitOrder[];
}

interface SubmitOrder {
  // EBICS order id to uniquely identify this order
  id: string;

  // EBICS order description provided by the EBICS server
  description: string;
}
POST /submit#

Submit an file to the EBICS server using a chosen order.

Request:

Form Parameters:

  • file – The file to submit.

  • order – The is of the EBICS order to use.

Response:

200 OK:

Response is a SubmitResponse.

400 Bad request:

Input data was invalid.

401 Unauthorized:

Invalid or missing credentials.

403 Forbidden:

Missing rights.

409 Conflict:

EBICS server validation error.

502 Bad Gateway:

EBICS server connection error.

Details:

interface SubmitResponse {
  // EBICS upload order ID
  order: string;
}