Stripe

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

• Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

  Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

• Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keine der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Operations-Liste aufgeführt.

• Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Stripe-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung in einer Integration über die Aufgabe „Connectors“ verwenden.

• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors-Aufgabe.

Aktionen

In diesem Abschnitt werden die vom Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

Aktion „ConfirmPaymentIntent“

Dadurch wird die Zahlungsabsicht bestätigt.

Eingabeparameter der Aktion „ConfirmPaymentIntent“

Beispiele für die Konfiguration der ConfirmPaymentIntent-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „CapturePaymentIntent“

Mit dieser Aktion wird die Zahlungsabsicht erfasst.

Eingabeparameter der CapturePaymentIntent-Aktion

Beispiele für die Konfiguration der ConfirmPaymentIntent-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „CancelPaymentIntent“

Durch diese Aktion wird die Zahlungsabsicht storniert.

Eingabeparameter der Aktion „CancelPaymentIntent“

Beispiele für die Konfiguration der CancelPaymentIntent-Aktion finden Sie unter Beispiele für Aktionen.

AttachPaymentMethodToCustomer-Aktion

Mit dieser Aktion wird einem Kunden ein PaymentMethod-Objekt zugewiesen.

Eingabeparameter der Aktion „AttachPaymentMethodToCustomer“

Beispiele für die Konfiguration der AttachPaymentMethodToCustomer-Aktion finden Sie unter Beispiele für Aktionen.

DetachPaymentMethodFromCustomer-Aktion

Mit dieser Aktion wird ein PaymentMethod-Objekt von einem Kunden getrennt. Nachdem eine Zahlungsmethode getrennt wurde, kann sie nicht mehr mit dem Kunden verknüpft werden.

Eingabeparameter der Aktion „DetachPaymentMethodFromCustomer“

Beispiele für die Konfiguration der DetachPaymentMethodFromCustomer-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „FinalizeInvoice“

Durch diese Aktion wird der Rechnungsentwurf fertiggestellt.

Eingabeparameter der Aktion „Rechnung abschließen“

Beispiele für die Konfiguration der FinalizeInvoice-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „FinalizeQuote“

Durch diese Aktion wird das Angebot fertiggestellt.

Eingabeparameter der FinalizeQuote-Aktion

Beispiele für die Konfiguration der FinalizeQuote-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „AcceptQuote“

Mit dieser Aktion wird das Angebot angenommen und eine Rechnung für das angenommene Angebot erstellt.

Eingabeparameter der AcceptQuote-Aktion

Beispiele für die Konfiguration der AcceptQuote-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „CancelQuote“

Durch diese Aktion wird das Angebot im Entwurf storniert.

Eingabeparameter der Aktion „CancelQuote“

Beispiele für die Konfiguration der CancelQuote-Aktion finden Sie unter Beispiele für Aktionen.

Beispiele für Aktionen

In diesem Abschnitt wird beschrieben, wie Sie einige der Aktionen in diesem Connector ausführen.

Beispiel – Zahlungsabsicht bestätigen

In diesem Beispiel wird gezeigt, wie die Absicht der angegebenen Zahlung bestätigt wird.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion ConfirmPaymentIntent aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "ReturnUrl": "http://google.com/",
   "PaymentIntentId": "pi_3OggwFANHgX3SHp71AVrNtT3"
   }

Wenn die Aktion erfolgreich ist, hat der connectorOutputPayload-Antwortparameter der ConfirmPaymentIntent-Aufgabe einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"id": "pi_3OggwFANHgX3SHp71AVrNtT3",
"object": "payment_intent",
"amount": "33000",
"amount_capturable": "0",
"amount_received": "33000",
"canceled_at": null,
"cancellation_reason": null,
"capture_method": "automatic",
"client_secret": "pi_3OggwFANHgX3SHp71AVrNtT3_secret_YEfjrYL5uHQZrGCx66cJbedlA",
"confirmation_method": "automatic",
"created": "1707196279",
"currency": "usd",
"invoice": null,
"last_payment_error": null,
"latest_charge": "ch_3OggwFANHgX3SHp71uYScRAw",
"level3": null,
"livemode": "false",
"next_action": null,
"on_behalf_of": null,
"payment_method": "pm_1Oggu6ANHgX3SHp7zaRNKNVL",
"payment_method_configuration_details": null,
"payment_method_options.card.installments": null,
"review": null,
"setup_future_usage": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
}]

Beispiel: Zahlungsabsicht erfassen

In diesem Beispiel wird gezeigt, wie die Absicht der angegebenen Zahlung erfasst wird.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CapturePaymentIntent aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des CapturePaymentIntent-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"id": "pi_3Ogh4sANHgX3SHp72YB0YotA",
"object": "payment_intent",
"amount": "33000",
"amount_capturable": "0",
"amount_received": "33000",
"canceled_at": null,
"cancellation_reason": null,
"capture_method": "manual",
"client_secret": "pi_3Ogh4sANHgX3SHp72YB0YotA_secret_jgqc0olEAOTcurQSDeQThJa3X",
"confirmation_method": "automatic",
"created": "1707196814",
"currency": "usd",
"customer": "cus_Okyi4e7t7BImUL",
"description": null,
"invoice": null,
"last_payment_error": null,
"latest_charge": "ch_3Ogh4sANHgX3SHp72uGBS7g4",
"level3": null,
"livemode": "false",
"next_action": null,
"on_behalf_of": null,
"payment_method": "pm_1Ogh4FANHgX3SHp7GBJJvfGR",
"payment_method_configuration_details": null,
"payment_method_options.card.installments": null,
"payment_method_types": null,
"processing": null,
"receipt_email": null,
"review": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
}]

Beispiel – Zahlungsabsicht abbrechen

In diesem Beispiel wird gezeigt, wie der Intent der angegebenen Zahlung abgebrochen wird.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CancelPaymentIntent aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des CancelPaymentIntent-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"id": "pi_3Ogh7HANHgX3SHp738skMdSQ",
"object": "payment_intent",
"amount": "33000",
"amount_capturable": "0",
"amount_received": "0",
"canceled_at": "1707197160",
"cancellation_reason": null,
"capture_method": "manual",
"client_secret": "pi_3Ogh7HANHgX3SHp738skMdSQ_secret_NqQsBexbdyk19ETdMnpQXF19j",
"confirmation_method": "automatic",
"created": "1707196963",
"currency": "usd",
"customer": "cus_Okyi4e7t7BImUL",
"description": null,
"invoice": null,
"last_payment_error": null,
"latest_charge": "ch_3Ogh7HANHgX3SHp73LJMZiy5",
"level3": null,
"livemode": "false",
"next_action": null,
"on_behalf_of": null,
"payment_method": "pm_1Ogh75ANHgX3SHp79MNT6IHs",
"payment_method_configuration_details": null,
"receipt_email": null,
"review": null,
"setup_future_usage": null,
"shipping": null,
"status": "canceled",
"transfer_data": null,
"transfer_group": null
}]

Beispiel: Zahlungsmethode mit einem Kunden verknüpfen

In diesem Beispiel wird gezeigt, wie Sie einem angegebenen Kunden eine Zahlungsmethode zuweisen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion AttachPaymentMethodToCustomer aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8",
   "CustomerId": "cus_PNX7n9xMDsMPH4"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des AttachPaymentMethodToCustomer-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiel – Zahlungsmethode von einem Kunden trennen

In diesem Beispiel wird gezeigt, wie Sie eine Zahlungsmethode von einem Kunden trennen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DetachPaymentMethodFromCustomer aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des DetachPaymentMethodFromCustomer-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiel: Rechnung abschließen

In diesem Beispiel wird gezeigt, wie Sie eine Rechnung abschließen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion FinalizeInvoice aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des Finalize Invoice -Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true",
"id": "in_1OhnXRANHgX3SHp73ufStlXy",
"object": "invoice",
"account_country": "US",
"account_name": "ZBTA_US_SAPDPA_TestAccount",
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": "1707459976",
"currency": "usd",
"discounts": null,
"due_date": null,
"effective_at": "1707460034",
"ending_balance": "0",
"footer": null,
"lines.data": null,
"lines.has_more": "false",
"lines.total_count": "0",
"livemode": "false",
"next_payment_attempt": null,
"number": "F3C0E263-0004",
"on_behalf_of": null,
"paid": "true",
"paid_out_of_band": "false",
"payment_intent": null,
}]

Beispiel: Angebot abschließen

In diesem Beispiel wird gezeigt, wie Sie ein Angebot abschließen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion FinalizeQuote aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des FinalizeQuote-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiel: Angebot annehmen

In diesem Beispiel wird gezeigt, wie Sie ein Angebot annehmen.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion AcceptQuote aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des AcceptQuote-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"InvoiceId": "in_1Obmr5ANHgX3SHp7HKi6bJDu",
"Success": "true"
}]

Beispiel: Angebot stornieren

In diesem Beispiel wird gezeigt, wie Sie ein Angebot stornieren.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CancelQuote aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des CancelQuote-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Beispiel: Alle Kunden auflisten

In diesem Beispiel werden alle Kunden in der Customer-Einheit aufgeführt.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Customer aus der Liste Entity aus.
3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors das Ergebnisset filtern, indem Sie eine Filterklausel angeben. Geben Sie den Wert der Filterklausel immer in einfachen Anführungszeichen (') an.

Beispiel: Kundendatensatz abrufen

In diesem Beispiel wird der angegebene Kundendatensatz abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Customer aus der Liste Entity aus.
3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann cus_OxHsz0u5bCGWuy in das Feld Standardwert ein.

   Dabei ist cus_OxHsz0u5bCGWuy eine eindeutige Datensatz-ID in der Customer-Entität.

Beispiel: Zahlungs-Intent erstellen

In diesem Beispiel wird ein Zahlungs-Intent in der PaymentIntent-Entität erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie PaymentIntent aus der Liste Entity aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "PaymentMethod": "pm_1OXN5YANHgX3SHp7Q5Y0rb39",
   "Currency": "usd",
   "Amount": 1500.0
   }

   Wenn die Integration erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

Beispiel: Kundendatensatz aktualisieren

In diesem Beispiel werden die Details des angegebenen Kunden aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Customer aus der Liste Entity aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "Name": "John"
   }

5. Klicken Sie auf entityId und geben Sie dann cus_OxHsz0u5bCGWuy in das Feld Standardwert ein.

   Wenn die Integration erfolgreich ist, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

Beispiel: Kundendatensatz löschen

In diesem Beispiel wird der angegebene Kunde aus der Customer-Entität gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie Customer aus der Liste Entity aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie auf EntityId und geben Sie dann cus_OxIqiMh1W335rE in das Feld Standardwert ein.