barcode-qr-code-sepa-payment-ean13

Report this endpoint's licence state for your token as JSON: the product, the tier free or pro, why it is not Pro, and the checkout URL. Call it to explain a free-tier refusal. No arguments, nothing changes.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Turn Pro on for this connection with key, an MCPL1.<payload>.<signature> issued at checkout for this server or the bundle. Data under your token stays; a wrong or expired key changes nothing. license_status confirms it.

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "License key from checkout, MCPL1.<payload>.<signature>"
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool to turn text or a URL into a QR code: SVG inline, or a PNG at a pixel size to out_path (Pro). Returns version, module grid and payload size. Free: 20 codes a month on this server.

{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "The text or URL the code carries"
    },
    "error_correction": {
      "type": "string",
      "enum": [
        "L",
        "M",
        "Q",
        "H"
      ],
      "description": "L 7%, M 15% (default), Q 25%, H 30% of the code recoverable when damaged"
    },
    "size": {
      "type": "integer",
      "description": "PNG width in pixels, 32 to 4000 (default 300). SVG scales without it"
    },
    "margin": {
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "description": "Quiet zone in modules, default 4, which is what the QR standard requires"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "required": [
    "text"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool to make a QR code that joins a WiFi network when scanned: ssid, password and auth type, written to out_path or returned as SVG. Free: 20 codes a month. qr_create takes plain text or a URL.

{
  "type": "object",
  "properties": {
    "ssid": {
      "type": "string",
      "description": "Network name, exactly as it appears"
    },
    "password": {
      "type": "string",
      "description": "Passphrase. Leave out only for an open network"
    },
    "auth": {
      "type": "string",
      "enum": [
        "WPA",
        "WEP",
        "nopass"
      ],
      "description": "WPA (default when a password is given), WEP, or nopass for an open network"
    },
    "hidden": {
      "type": "boolean",
      "description": "True if the network does not broadcast its name"
    },
    "error_correction": {
      "type": "string",
      "enum": [
        "L",
        "M",
        "Q",
        "H"
      ],
      "description": "L 7%, M 15% (default), Q 25%, H 30% of the code recoverable when damaged"
    },
    "size": {
      "type": "integer",
      "description": "PNG width in pixels, 32 to 4000 (default 300). SVG scales without it"
    },
    "margin": {
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "description": "Quiet zone in modules, default 4, which is what the QR standard requires"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "required": [
    "ssid"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool to make a QR code that adds a contact when scanned (vCard 3.0). For your own card pass nothing: name, phone, email and address default to the shared business profile, never asked for.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Full name, for example Anna Kowalska. Defaults to the shared business profile's name; pass it only for someone else's card"
    },
    "org": {
      "type": "string",
      "description": "Company or organisation"
    },
    "title": {
      "type": "string",
      "description": "Job title"
    },
    "phone": {
      "type": "string",
      "description": "Phone number, in the form it should be dialled. Defaults to the shared business profile"
    },
    "email": {
      "type": "string",
      "description": "Email address. Defaults to the shared business profile"
    },
    "url": {
      "type": "string",
      "description": "Website"
    },
    "address": {
      "type": "string",
      "description": "Postal address, one line. Defaults to the shared business profile"
    },
    "note": {
      "type": "string",
      "description": "Free note stored on the contact"
    },
    "error_correction": {
      "type": "string",
      "enum": [
        "L",
        "M",
        "Q",
        "H"
      ],
      "description": "L 7%, M 15% (default), Q 25%, H 30% of the code recoverable when damaged"
    },
    "size": {
      "type": "integer",
      "description": "PNG width in pixels, 32 to 4000 (default 300). SVG scales without it"
    },
    "margin": {
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "description": "Quiet zone in modules, default 4, which is what the QR standard requires"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool for an EPC069-12 payment QR a euro banking app can scan. Amount and reference are enough: the beneficiary IBAN and name default to the shared business profile, never asked for.

{
  "type": "object",
  "properties": {
    "iban": {
      "type": "string",
      "description": "Beneficiary IBAN. Defaults to the iban in the shared business profile (set once with the invoice server's business_set). Checked with ISO 7064 mod 97 and refused if it does not validate"
    },
    "name": {
      "type": "string",
      "description": "Beneficiary name, up to 70 characters. Defaults to the name in the shared business profile"
    },
    "amount": {
      "type": "number",
      "description": "Amount in EUR, 0.01 to 999999999.99. Leave out and the payer types it"
    },
    "currency": {
      "type": "string",
      "description": "EUR only; any other value is refused, because EPC encodes a SEPA credit transfer"
    },
    "bic": {
      "type": "string",
      "description": "Beneficiary BIC. Optional under EPC version 002"
    },
    "remittance": {
      "type": "string",
      "description": "Free payment text, up to 140 characters, for example an invoice number"
    },
    "reference": {
      "type": "string",
      "description": "Structured creditor reference (RF...), up to 35. Use this OR remittance, never both"
    },
    "purpose": {
      "type": "string",
      "description": "Four-letter ISO 20022 purpose code, for example GDDS"
    },
    "error_correction": {
      "type": "string",
      "enum": [
        "L",
        "M",
        "Q",
        "H"
      ],
      "description": "L 7%, M 15% (default), Q 25%, H 30% of the code recoverable when damaged"
    },
    "size": {
      "type": "integer",
      "description": "PNG width in pixels, 32 to 4000 (default 300). SVG scales without it"
    },
    "margin": {
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "description": "Quiet zone in modules, default 4, which is what the QR standard requires"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool for a SEPA payment QR from just an amount and reference: IBAN and name are read from the shared business profile, never asked for; pass invoice_id instead to take the amount from an invoice.

{
  "type": "object",
  "properties": {
    "invoice_id": {
      "type": "string",
      "description": "Invoice number, for example INV-2026-0007. Read from the invoice server's store if it is present"
    },
    "amount": {
      "type": "number",
      "description": "Amount in EUR. Overrides the invoice total; required when there is no invoice to read"
    },
    "reference": {
      "type": "string",
      "description": "Payment text, up to 140 characters. Defaults to the invoice number"
    },
    "iban": {
      "type": "string",
      "description": "Override the IBAN in the shared business profile"
    },
    "name": {
      "type": "string",
      "description": "Override the beneficiary name in the shared business profile"
    },
    "error_correction": {
      "type": "string",
      "enum": [
        "L",
        "M",
        "Q",
        "H"
      ],
      "description": "L 7%, M 15% (default), Q 25%, H 30% of the code recoverable when damaged"
    },
    "size": {
      "type": "integer",
      "description": "PNG width in pixels, 32 to 4000 (default 300). SVG scales without it"
    },
    "margin": {
      "type": "integer",
      "minimum": 0,
      "maximum": 20,
      "description": "Quiet zone in modules, default 4, which is what the QR standard requires"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool to draw a linear barcode (code128, ean13, ean8, upca) as SVG, or PNG to out_path. A short EAN or UPC gets its check digit computed; a wrong one is refused, never redrawn. qr_create makes QR codes.

{
  "type": "object",
  "properties": {
    "symbology": {
      "type": "string",
      "enum": [
        "code128",
        "ean13",
        "ean8",
        "upca"
      ],
      "description": "code128 for any printable ASCII, ean13 and ean8 for retail products, upca for North American retail"
    },
    "value": {
      "type": "string",
      "description": "The data to encode. Digits only for EAN and UPC"
    },
    "module_width": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "description": "Width of the narrowest bar, in pixels or SVG units (default 2)"
    },
    "height": {
      "type": "integer",
      "minimum": 10,
      "maximum": 1000,
      "description": "Bar height in the same units (default 80)"
    },
    "text": {
      "type": "boolean",
      "description": "Print the digits under the bars (default true)"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "required": [
    "symbology",
    "value"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool to draw many barcodes or QR codes at once from a list of rows, each with its own value and file name. Every row comes back as its own download link valid for one hour. Pro; the free tier does one code per call.

{
  "type": "object",
  "properties": {
    "out_dir": {
      "type": "string",
      "description": "Ignored on this hosted endpoint: there are no directories, and every row comes back as its own download link"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "description": "The data to encode"
          },
          "symbology": {
            "type": "string",
            "enum": [
              "code128",
              "ean13",
              "ean8",
              "upca",
              "qr"
            ],
            "description": "Defaults to the call's symbology"
          },
          "filename": {
            "type": "string",
            "description": "File name without an extension. Defaults to the value, made safe"
          }
        },
        "required": [
          "value"
        ],
        "additionalProperties": false
      },
      "description": "The rows to draw"
    },
    "symbology": {
      "type": "string",
      "enum": [
        "code128",
        "ean13",
        "ean8",
        "upca",
        "qr"
      ],
      "description": "Default symbology for rows that do not name one (default code128)"
    },
    "stop_on_error": {
      "type": "boolean",
      "description": "Stop at the first bad row instead of drawing the rest and reporting it (default false)"
    },
    "module_width": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "description": "Width of the narrowest bar, in pixels or SVG units (default 2)"
    },
    "height": {
      "type": "integer",
      "minimum": 10,
      "maximum": 1000,
      "description": "Bar height in the same units (default 80)"
    },
    "text": {
      "type": "boolean",
      "description": "Print the digits under the bars (default true)"
    },
    "format": {
      "type": "string",
      "enum": [
        "svg",
        "png"
      ],
      "description": "svg (default, free) or png (Pro)"
    },
    "out_path": {
      "type": "string",
      "description": "Name for the downloaded file, e.g. acme-code. SVG is returned inline when this is left out; a PNG always comes back as a download link valid for one hour"
    },
    "overwrite": {
      "type": "boolean",
      "description": "Replace a file of the same name already produced in this request (default false)"
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List the codes this server generated, newest first, with what each carried and where it went, plus how much of the free 20 a month is used. Filter by kind. It reads the register, not the files.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "How many rows to show, newest first (default 20)"
    },
    "kind": {
      "type": "string",
      "description": "Only rows of this kind: text, wifi, vcard, sepa, invoice, barcode or batch"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}