GNU Taler

https://docs.taler.net/
Admin
GNU Taler is an anonymous, taxable payment system using modern cryptography. Customers use...
Tokens:1,196,979
Snippets:7,822
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start EBICS setup to create new client keys

Source: https://docs.taler.net/libeufin/ebisync-manual.html

Command to start the EBICS setup process. If it fails with EBICS_INVALID_USER_OR_USER_STATE, you must confirm your keys to the bank using the generated PDF.

```bash
$ sudo -u libeufin-ebisync libeufin-ebisync setup -c /etc/libeufin-ebisync/libeufin-ebisync.conf

```

--------------------------------

### Run the guided configuration script

Source: https://docs.taler.net/regional/regional-automated-manual.html

Navigate to the regional-currency directory and run main.sh as root. The script installs packages and asks configuration questions.

```bash
$ cd taler-deployment/regional-currency/
# ./main.sh
```

--------------------------------

### Start libeufin-based benchmark setup

Source: https://docs.taler.net/taler-exchange-manual.html

Use this command to launch a benchmark deployment with libeufin. It resets the talercheck database and runs taler-unified-setup.sh with -ns for libeufin and -u exchange-account-2.

```bash
$ dropdb talercheck; createdb talercheck
$ taler-unified-setup.sh -emwt -c $CONF -ns -u exchange-account-2

```

--------------------------------

### Start fakebank-based benchmark setup

Source: https://docs.taler.net/taler-exchange-manual.html

Use this command to launch a benchmark deployment with the fakebank. It resets the talercheck database and runs taler-unified-setup.sh with -f for fakebank and -u exchange-account-1.

```bash
$ dropdb talercheck; createdb talercheck
$ taler-unified-setup.sh -emwt -c $CONF -f -u exchange-account-1

```

--------------------------------

### Build and install Taler merchant backend from source

Source: https://docs.taler.net/taler-merchant-manual.html

Configure, build, and install the merchant backend. Specify --with-gnunet and --with-exchange if those were installed to non-standard prefixes. Run make install as root if prefix is /usr/local. Run make check only after make install.

```bash
$ ./configure [--prefix=PFX] \
              [--with-gnunet=GNUNETPFX] \
              [--with-exchange=EXCHANGEPFX]
$ # Each dependency can be fetched from non standard locations via
$ # the '--with-<LIBNAME>' option. See './configure --help'.
$ make
# make install

```

--------------------------------

### Run depolymerizer-bitcoin setup (simple setup)

Source: https://docs.taler.net/depolymerization/bitcoin-manual.html

Runs the setup process for the depolymerizer-bitcoin using the config file variable.

```bash
$ depolymerizer-bitcoin -c "$CONFIG_FILE" setup

```

--------------------------------

### Build and install GNUnet from source

Source: https://docs.taler.net/taler-auditor-manual.html

Configures, compiles, and installs GNUnet. Use --prefix to set the installation prefix and --with-<LIBNAME> for non-standard dependency locations. Run make install and ldconfig as root if no prefix is specified.

```bash
$ ./configure [--prefix=GNUNETPFX]
$ # Each dependency can be fetched from non standard locations via
$ # the '--with-<LIBNAME>' option. See './configure --help'.
$ make
# make install
# ldconfig

```

--------------------------------

### Install Rust and C toolchain

Source: https://docs.taler.net/depolymerization/bitcoin-manual.html

Installs rustup and build-essential, then installs the latest stable Rust toolchain.

```bash
$ sudo apt install rustup build-essential
$ rustup toolchain install stable

```

--------------------------------

### Build and install Debian package

Source: https://docs.taler.net/depolymerization/bitcoin-manual.html

Builds a Debian/Ubuntu package with automated secure setup and systemd services, then installs it with dpkg. After success, the depolymerizer-bitcoin command should be in $PATH.

```bash
$ sudo apt install debhelper
$ make deb
$ sudo dpkg -i ../depolymerizer-bitcoin*.deb

```

--------------------------------

### GET /public-accounts

Source: https://docs.taler.net/core/api-corebank.html

Shows those accounts whose histories are publicly visible. For example, accounts from donation receivers. As such, this request is unauthenticated.

```APIDOC
## GET /public-accounts

### Description
Shows those accounts whose histories are publicly visible. For example, accounts from donation receivers. As such, this request is unauthenticated.

### Method
GET

### Endpoint
/public-accounts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - At most return the given number of results. Negative for descending by `row_id`, positive for ascending by `row_id`. Defaults to `-20`. Since **v5**.
- **offset** (integer) - Optional - Starting `row_id` for pagination. Since **v5**.
- **filter_name** (string) - Optional - Pattern to filter on the account's legal name. Given the filter 'foo', all the results will **contain** 'foo' in their legal name. Without this option, all the existing accounts are returned.
- **delta** (integer) - Optional - Deprecated since **v5**. Use _limit_ instead.
- **start** (integer) - Optional - Deprecated since **v5**. Use _offset_ instead.

### Response
#### Success Response (200 OK)
Response is a PublicAccountsResponse.

#### Success Response (204 No Content)
No public account.

### Details
```
interface PublicAccountsResponse {
  public_accounts: PublicAccount[];
}
```

```
interface PublicAccount {
  // Username of the account
  username: Slug;

  // Full payto URI of this bank account.
  payto_uri: string;

  // Current balance of the account
  balance: Balance;

  // Is this a taler exchange account?
  is_taler_exchange: boolean;

  // Opaque unique ID used for pagination.
  // @since **v4**, will become mandatory in the next version.
  row_id?: Integer;
}
```
```

--------------------------------

### Start taler-magnet-bank.target

Source: https://docs.taler.net/taler-magnet-bank-manual.html

Launches the main adapter process using systemd.

```bash
$ sudo systemctl start taler-magnet-bank.target

```

--------------------------------

### Load an existing Bitcoin wallet (simple setup)

Source: https://docs.taler.net/depolymerization/bitcoin-manual.html

Loads an existing wallet using bitcoin-cli without sudo.

```bash
$ bitcoin-cli loadwallet $WALLET

```

--------------------------------

### Create a new Bitcoin wallet (simple setup)

Source: https://docs.taler.net/depolymerization/bitcoin-manual.html

Creates a new wallet using bitcoin-cli without sudo.

```bash
$ bitcoin-cli createwallet $WALLET false false $PASSWORD

```

--------------------------------

### getQrCodesForPayto

Source: https://docs.taler.net/core/api-wallet-core.html

Gets QR code representations of a payto URI, for example to let the user scan the code with a banking app. This operation is deprecated; consult the withdrawal transaction details instead.

```APIDOC
## getQrCodesForPayto

### Description
Get QR code representations of a payto URI, for example to let the user scan the code with a banking app. This operation is **deprecated**. Consult the withdrawal transaction details instead. All applicable QR code specifications are returned (an EPC QR code and/or a Swiss QR bill); the list is empty when none applies to the given payto URI.

### Method
_read-only_ _deprecated_

### Request
- **paytoUri** (string) - Required - The payto URI to generate QR codes for.

### Response
- **codes** (array of QrCodeSpec) - The list of QR code specifications.
  - **type** (string) - The type of the QR code: "epc-qr" or "spc".
  - **qrContent** (string) - The content of the QR code that should be rendered.

### Request Example
```json
{
  "paytoUri": "payto:iban/..."
}
```

### Response Example
```json
{
  "codes": [
    {
      "type": "epc-qr",
      "qrContent": "BCD..."
    }
  ]
}
```
```

--------------------------------

### Configure MASTER_PUBLIC_KEY in exchange-business.conf

Source: https://docs.taler.net/taler-exchange-manual.html

Place the master public key printed by the setup command into the [exchange] section of the online machine's configuration file. The value shown is an example; replace it with the actual key.

```ini
[exchange]
MASTER_PUBLIC_KEY = YE6Q6TR1ED...

# ... rest of file ...
```

--------------------------------

### Build and install from source

Source: https://docs.taler.net/taler-paivana-manual.html

Commands to bootstrap, configure, build, and install paivana-httpd from source. Requires GNUnet, Taler exchange libraries, merchant client library, HTTP daemon helpers, and other dependencies.

```bash
$ ./bootstrap
$ ./configure --prefix=$PREFIX
$ make
$ sudo make install
```

--------------------------------

### GET /${RESOURCE...}/tokens

Source: https://docs.taler.net/design-documents/049-auth.html

Lists existing token information. Supports pagination via delta and start query parameters. Returns a list of token info objects or 204 No Content if no tokens exist.

```APIDOC
## GET /${RESOURCE...}/tokens

### Description
List existing token information. Supports pagination via delta and start query parameters. Returns a list of token info objects or 204 No Content if no tokens exist.

### Method
GET

### Endpoint
/${RESOURCE...}/tokens

### Parameters
#### Query Parameters
- **delta** (string) - Optional - Takes value of the form `N (-N)`, so that at most `N` values strictly older (younger) than `start` are returned. Defaults to `-20` to return the last 20 entries.
- **start** (integer) - Optional - Row number threshold, see `delta` for its interpretation. Defaults to smallest or biggest row id possible according to `delta` sign.

### Response
#### Success Response (200)
- **tokens** (array of TokenInfo) - List of token information objects.

#### Response Example
{
  "tokens": [
    {
      "creation_time": "2026-08-29T12:00:00Z",
      "expiration": "2026-08-30T12:00:00Z",
      "scope": "readonly",
      "refreshable": true,
      "description": "Example token",
      "last_access": "2026-08-29T12:00:00Z",
      "row_id": 1
    }
  ]
}

#### Success Response (204)
No tokens.
```

--------------------------------

### KYC provider configuration example

Source: https://docs.taler.net/taler-kyc-manual.html

Configuration section for a KYC provider, identified by a section name starting with 'kyc-provider-'. The LOGIC option selects the plugin (e.g., 'oauth2'), and additional logic-specific options like AUTHORIZATION_TOKEN and FORM_ID are provided.

```ini
[kyc-provider-$PROVIDER_ID]

# Which plugin is responsible for this provider?
# Choices include "oauth2", "kycaid" and "persona".
LOGIC = oauth2

# Plus additional logic-specific options, e.g.:
AUTHORIZATION_TOKEN = superdupersecret

# Other logic-specific internal options (example):
FORM_ID = business_legi_form

```

--------------------------------

### Initialize database schema (simple setup)

Source: https://docs.taler.net/depolymerization/bitcoin-manual.html

Command to initialize or upgrade the database schema using the config file variable.

```bash
$ depolymerizer-bitcoin -c "$CONFIG_FILE" dbinit

```

--------------------------------

### Prepare auditor report compiler worker

Source: https://docs.taler.net/developer/taler-developer-manual.html

Commands to prepare the Buildbot worker for compiling auditor reports for both 'test' and 'demo' setups. Run as <env>-auditor, where <env> is either 'test' or 'demo'. Clones the deployment repository, runs the prepare-auditorreporter script with the environment, and starts the worker.

```bash
# Log-in as <env>-auditor, with <env> being either 'test' or 'demo'

$ git clone git://git.taler.net/deployment
$ ./deployment/buildbot/bootstrap-scripts/prepare-auditorreporter <env>

# If the previous steps worked, then it should suffice to start
# the worker, with:

$ buildbot-worker start worker/
```

--------------------------------

### Complete backend configuration example

Source: https://docs.taler.net/taler-merchant-manual.html

A full example of a merchant backend configuration, including merchant settings, PostgreSQL database, and exchange details. Note the comment about multi-currency support being experimental.

```ini
[merchant]
# Default currency; note that multi-currency support is still
# a bit experimental...
CURRENCY = KUDOS
SERVE = TCP
PORT = 9966
DATABASE = postgres

[merchantdb-postgres]
CONFIG = postgres:///taler-merchant

[merchant-exchange-kudos]
EXCHANGE_BASE_URL = https://exchange.demo.taler.net/
MASTER_KEY = FH1Y8ZMHCTPQ0YFSZECDH8C9407JR3YN0MF1706PTG24Q4NEWGV0
CURRENCY = KUDOS

```

--------------------------------

### Build and install GNU Taler exchange from source

Source: https://docs.taler.net/taler-auditor-manual.html

Configures, compiles, and installs the GNU Taler exchange. Use --prefix to set the installation prefix and --with-gnunet to point to the GNUnet installation. Run make install as root if no prefix is specified.

```bash
$ ./configure [--prefix=EXCHANGEPFX] \
              [--with-gnunet=GNUNETPFX]
$ # Each dependency can be fetched from non standard locations via
$ # the '--with-<LIBNAME>' option. See './configure --help'.
$ make
# make install

```
Tokens:
Raw