RessourcenZahlungsmethoden

Zahlungsmethoden

Listen Sie Zahlungsmethoden auf, fügen Sie diese hinzu, setzen Sie eine Standardmethode und entfernen Sie Zahlungsmethoden über die Talkturo API — verwalten Sie Stripe-basierte Karten für Workspace-Abrechnung und Guthabenkäufe.

curl -X GET "https://app.talkturo.com/api/payment-methods?accountId=acc_9f3a2b1c" \
  -H "Authorization: Bearer tk_example_9xmk7q2r"
{
  "success": true,
  "paymentMethods": [
    {
      "id": "c8b2b7d3-6df5-4d0f-8d18-2e23ef9df4f1",
      "stripe_payment_method_id": "pm_1Qp7K2ABCD3EfghI9jKlmnOp",
      "type": "card",
      "card_brand": "visa",
      "card_last4": "4242",
      "card_exp_month": 12,
      "card_exp_year": 2028,
      "card_funding": "credit",
      "is_default": true,
      "is_active": true,
      "billing_details": {
        "name": "Jane Chen",
        "email": "jane@acme.com"
      },
      "created_at": "2025-02-14T10:21:33.000Z"
    }
  ],
  "count": 1
}
curl -X POST "https://app.talkturo.com/api/payment-methods" \
  -H "Authorization: Bearer tk_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_9f3a2b1c",
    "paymentMethodId": "pm_1Qp7K2ABCD3EfghI9jKlmnOp",
    "setAsDefault": true
  }'
{
  "success": true,
  "paymentMethod": {
    "id": "c8b2b7d3-6df5-4d0f-8d18-2e23ef9df4f1",
    "stripe_payment_method_id": "pm_1Qp7K2ABCD3EfghI9jKlmnOp",
    "card_brand": "visa",
    "card_last4": "4242",
    "card_exp_month": 12,
    "card_exp_year": 2028,
    "is_default": true
  }
}
curl -X DELETE "https://app.talkturo.com/api/payment-methods/c8b2b7d3-6df5-4d0f-8d18-2e23ef9df4f1" \
  -H "Authorization: Bearer tk_example_9xmk7q2r"
{
  "success": true,
  "message": "Payment method deleted"
}
curl -X PATCH "https://app.talkturo.com/api/payment-methods/c8b2b7d3-6df5-4d0f-8d18-2e23ef9df4f1" \
  -H "Authorization: Bearer tk_example_9xmk7q2r" \
  -H "Content-Type: application/json"
{
  "success": true,
  "message": "Default payment method updated"
}

Verwaltung von Zahlungsmethoden

Verwalten Sie gespeicherte Zahlungsmethoden für Workspace-Abrechnung und Guthabenkäufe über die Talkturo API. Diese Endpunkte arbeiten mit Stripe-basierten Karten und unterstützen Session-Cookies oder API-Schlüssel über withApiAuth.

Base URL: https://app.talkturo.com
Authentifizierung: Session-Cookie oder Authorization: Bearer tk_...

Endpunkte

Zahlungsmethoden auflisten

Rufen Sie alle aktiven und gespeicherten Zahlungsmethoden für einen Workspace ab.

Anfrageparameter

query
accountIdstring

Workspace-ID. Bei API-Schlüsseln ist dieser Wert optional, wenn der Schlüssel bereits an den Workspace gebunden ist.

Antwortfelder

successboolean
Required

Gibt an, ob die Anfrage erfolgreich war.

paymentMethodsarray
Required

Liste der gespeicherten Zahlungsmethoden des Workspace.

countnumber
Required

Anzahl der zurückgegebenen Zahlungsmethoden.

Objekte in paymentMethods

idstring
Required

Interne UUID der Zahlungsmethode in Talkturo.

stripe_payment_method_idstring
Required

Stripe-ID der Zahlungsmethode, in der Regel beginnend mit pm_.

typestring
Required

Typ der Zahlungsmethode. Für diese Endpunkte ist dies typischerweise card.

card_brandstring

Kartenmarke, zum Beispiel visa oder mastercard.

card_last4string

Die letzten vier Ziffern der Karte.

card_exp_monthnumber

Ablaufmonat der Karte.

card_exp_yearnumber

Ablaufjahr der Karte.

card_fundingstring

Finanzierungsart der Karte, zum Beispiel credit oder debit.

is_defaultboolean
Required

Gibt an, ob diese Zahlungsmethode aktuell die Standardmethode ist.

is_activeboolean
Required

Gibt an, ob die Zahlungsmethode aktiv verwendet werden kann.

billing_detailsobject

Abrechnungsdetails, die von Stripe für die Zahlungsmethode gespeichert wurden.

created_atstring
Required

Zeitpunkt der Erstellung im ISO-8601-Format.

Zahlungsmethode hinzufügen

Fügen Sie einem Workspace eine neue Stripe-Zahlungsmethode hinzu. Optional können Sie die neue Methode sofort als Standard festlegen.

Anfrage-Body

accountIdstring
Required

Workspace-ID, zu der die Zahlungsmethode hinzugefügt wird.

paymentMethodIdstring
Required

Stripe-ID der Zahlungsmethode. Verwenden Sie eine gültige ID, die mit pm_ beginnt.

setAsDefaultboolean

Legt fest, ob die neue Zahlungsmethode direkt als Standard gesetzt wird. Standardwert ist false.

Antwortfelder

successboolean
Required

Gibt an, ob die Zahlungsmethode erfolgreich hinzugefügt wurde.

paymentMethodobject
Required

Die neu gespeicherte Zahlungsmethode.

paymentMethod.idstring
Required

Interne UUID der neu erstellten Zahlungsmethode.

paymentMethod.stripe_payment_method_idstring
Required

Stripe-ID der gespeicherten Zahlungsmethode.

paymentMethod.card_brandstring

Kartenmarke der gespeicherten Karte.

paymentMethod.card_last4string

Die letzten vier Ziffern der gespeicherten Karte.

paymentMethod.card_exp_monthnumber

Ablaufmonat der Karte.

paymentMethod.card_exp_yearnumber

Ablaufjahr der Karte.

paymentMethod.is_defaultboolean
Required

Gibt an, ob diese Zahlungsmethode nun die Standardmethode ist.

Zahlungsmethode entfernen

Entfernen Sie eine gespeicherte Zahlungsmethode anhand ihrer internen UUID.

Pfadparameter

path
idstring
Required

Interne UUID der zu entfernenden Zahlungsmethode.

Antwortfelder

successboolean
Required

Gibt an, ob die Zahlungsmethode erfolgreich entfernt wurde.

messagestring
Required

Statusmeldung der API. Bei Erfolg ist der Wert Payment method deleted.

Standard-Zahlungsmethode festlegen

Setzen Sie eine vorhandene gespeicherte Zahlungsmethode als Standard für künftige Abrechnungen und Guthabenkäufe.

Pfadparameter

path
idstring
Required

Interne UUID der Zahlungsmethode, die als Standard gesetzt werden soll.

Antwortfelder

successboolean
Required

Gibt an, ob die Standard-Zahlungsmethode erfolgreich aktualisiert wurde.

messagestring
Required

Statusmeldung der API. Bei Erfolg ist der Wert Default payment method updated.

Hinweise zur Verwendung

Verwenden Sie beim Hinzufügen einer Karte die Stripe-paymentMethodId und beim Aktualisieren oder Löschen die interne Talkturo-id. Diese beiden Werte sind nicht austauschbar.

Wenn Sie einen API-Schlüssel verwenden, kann der Workspace-Kontext aus dem Schlüssel selbst abgeleitet werden. Bei sessionbasierten Anfragen müssen Sie den Workspace-Kontext gegebenenfalls explizit übergeben.

Verwandte Ressourcen