Auflisten

API-Schlüssel: Payment

Gibt die für diese Zugangsdaten sichtbaren Kanäle zurück, neueste zuerst. Nutzen Sie die Liste, um Ihre eigenen Kundendatensätze mit unseren abzugleichen oder einen Kanal über die von Ihnen vergebene external_id zu finden.

Query-Parameter

Parameter	Typ	Standard	Beschreibung
limit	Ganzzahl	20	Seitengröße von 1 bis 100.
cursor	Zeichenkette	—	Undurchsichtiger Cursor aus dem next_cursor der vorherigen Seite.
status	Zeichenkette	—	active, blocked oder provisioning. Darf wiederholt werden; Dubletten werden abgewiesen.
external_id	Zeichenkette	—	Exakte Übereinstimmung mit der beim Anlegen vergebenen Kennung.
project_id	Zeichenkette	—	Auf ein Projekt einschränken (prj_…).

Jeder andere Parameter wird abgewiesen. Es gibt weder external_order_id noch created_from / created_to: Die gehören zu Rechnungen und Auszahlungen, nicht zu Kanälen.

Beispiel

GET /v1/payment-channels?limit=50&status=active&status=provisioning HTTP/1.1
Host: api.paymos.io
Authorization: HMAC-SHA256 pk_live_…:…
X-Request-Timestamp: 1767225660

Antwort (200 OK)

{
  "items": [
    {
      "id": "pc_2QhKZv6mRt9WdA3nYpLbXf",
      "project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
      "external_id": "customer-42",
      "status": "active",
      "is_accepting_payments": true,
      "is_fully_provisioned": false,
      "is_test": false,
      "applied_fee_percent": 1.0,
      "customer_fee_percent": 0,
      "networks": [
        {
          "network": "TRC20",
          "status": "active",
          "address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
          "tokens": [
            { "symbol": "USDT", "minimum_deposit": "1.00" },
            { "symbol": "USDC", "minimum_deposit": "1.00" }
          ]
        },
        {
          "network": "ERC20",
          "status": "active",
          "address": "0x9f2a6c1b4e8d7350ab11c9e5f0d2743b86ce41d9",
          "tokens": [
            { "symbol": "USDT", "minimum_deposit": "12.00" },
            { "symbol": "USDC", "minimum_deposit": "12.00" }
          ]
        },
        {
          "network": "SOL",
          "status": "provisioning",
          "tokens": [
            { "symbol": "USDC", "minimum_deposit": null }
          ]
        }
      ],
      "created_at": 1767225600,
      "updated_at": 1767225780
    },
    {
      "id": "pc_6BwTyH4nPl8QmZ2vKrJdSc",
      "project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
      "external_id": "customer-41",
      "status": "provisioning",
      "is_accepting_payments": false,
      "is_fully_provisioned": false,
      "is_test": false,
      "applied_fee_percent": 1.0,
      "customer_fee_percent": 0,
      "networks": [
        {
          "network": "TRC20",
          "status": "provisioning",
          "tokens": [
            { "symbol": "USDT", "minimum_deposit": null },
            { "symbol": "USDC", "minimum_deposit": null }
          ]
        },
        {
          "network": "ERC20",
          "status": "provisioning",
          "tokens": [
            { "symbol": "USDT", "minimum_deposit": null },
            { "symbol": "USDC", "minimum_deposit": null }
          ]
        },
        {
          "network": "SOL",
          "status": "provisioning",
          "tokens": [
            { "symbol": "USDC", "minimum_deposit": null }
          ]
        }
      ],
      "created_at": 1767225540,
      "updated_at": 1767225540
    }
  ],
  "next_cursor": "CfDJ8JvN…"
}

Seitennavigation

Sortiert wird nach created_at, danach nach der Kanalkennung, beides absteigend — die Reihenfolge bleibt also stabil, während Sie blättern.

• —next_cursor ist auf der letzten Seite null. Das ist das Signal aufzuhören.
• —Ein Cursor ist an die Filter gebunden, aus denen er entstanden ist. Ändern Sie status, external_id oder project_id und legen den alten Cursor erneut vor, antwortet die API mit 400 pagination_cursor_invalid — die Alternative wäre, Zeilen stillschweigend zu überspringen, die Sie nie gesehen haben.
• —Cursor laufen 24 Stunden nach ihrer Ausgabe ab. Danach beginnen Sie wieder bei der ersten Seite.
• —Eine project_id außerhalb des Geltungsbereichs Ihrer Zugangsdaten liefert eine leere Seite statt einer 404, sodass die API nie bestätigt, ob ein für Sie unsichtbares Projekt existiert.

Fehler

Code	HTTP	Wann
payment_channels_disabled	503	Zahlungskanäle sind für Ihr Konto in dieser Umgebung nicht freigeschaltet.
payment_key_required	403	Die Anfrage wurde mit einem Payout-Schlüssel (rk_) signiert.
pagination_cursor_invalid	400	Der Cursor ist fehlerhaft, abgelaufen oder an andere Filter gebunden.
field_invalid_enum	400	Ein unbekannter Wert für status.
field_invalid_format	400	project_id ist keine gültige prj_-Kennung, oder derselbe status wurde zweimal übergeben.
payment_channel_external_id_invalid	400	external_id ist länger als 128 Zeichen.
field_out_of_range	400	limit liegt außerhalb von 1–100.
query_parameter_unknown	400	Ein Parameter, der nicht in der Tabelle oben steht.

Den vollständigen Katalog finden Sie unter Fehlercodes.