Stripe

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

在整合服務中使用 Stripe 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連線器」工作使用連線。

• 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。
• 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。

動作

本節列出連接器支援的操作。如要瞭解如何設定動作，請參閱「動作範例」。

ConfirmPaymentIntent 動作

這項動作會確認付款意圖。

ConfirmPaymentIntent 動作的輸入參數

如要瞭解如何設定 ConfirmPaymentIntent 動作，請參閱動作範例。

CapturePaymentIntent 動作

這項操作會擷取付款意圖。

CapturePaymentIntent 動作的輸入參數

如要瞭解如何設定 ConfirmPaymentIntent 動作，請參閱動作範例。

CancelPaymentIntent 動作

這項操作會取消付款意圖。

CancelPaymentIntent 動作的輸入參數

如要瞭解如何設定 CancelPaymentIntent 動作，請參閱動作範例。

AttachPaymentMethodToCustomer 動作

這項動作會將 PaymentMethod 物件附加至顧客。

AttachPaymentMethodToCustomer 動作的輸入參數

如要瞭解如何設定 AttachPaymentMethodToCustomer 動作，請參閱動作範例。

DetachPaymentMethodFromCustomer 動作

這項操作會將 PaymentMethod 物件從顧客中分離。付款方式分離後，就無法重新附加至顧客。

DetachPaymentMethodFromCustomer 動作的輸入參數

如要瞭解如何設定 DetachPaymentMethodFromCustomer 動作，請參閱動作範例。

FinalizeInvoice 動作

這項操作會完成草擬的月結單。

「結算月結單」動作的輸入參數

如要瞭解如何設定 FinalizeInvoice 動作，請參閱動作範例。

FinalizeQuote 動作

這項操作會完成草擬的報價。

FinalizeQuote 動作的輸入參數

如要瞭解如何設定 FinalizeQuote 動作，請參閱「動作範例」。

AcceptQuote 動作

這項動作會接受報價，並為接受的報價產生發票。

AcceptQuote 動作的輸入參數

如要瞭解如何設定 AcceptQuote 動作，請參閱「動作範例」。

CancelQuote 動作

這項操作會取消草擬的報價。

CancelQuote 動作的輸入參數

如要瞭解如何設定 CancelQuote 動作，請參閱「動作範例」。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 確認付款意圖

這個範例說明如何確認指定付款的意圖。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 ConfirmPaymentIntent 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

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

如果動作成功，ConfirmPaymentIntent 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"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
}]

範例 - 擷取付款意圖

以下範例說明如何擷取指定付款的意圖。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CapturePaymentIntent 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
   }

如果動作成功，CapturePaymentIntent 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"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
}]

範例 - 取消付款意圖

以下範例說明如何取消指定付款的意圖。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CancelPaymentIntent 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
   }

如果動作成功，CancelPaymentIntent 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"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
}]

範例 - 將付款方式附加至客戶

這個範例說明如何將付款方式附加至指定客戶。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 AttachPaymentMethodToCustomer 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

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

如果動作成功，AttachPaymentMethodToCustomer 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

範例 - 從客戶卸離付款方式

這個範例說明如何從顧客卸離付款方式。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 DetachPaymentMethodFromCustomer 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
   }

如果動作成功，DetachPaymentMethodFromCustomer 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

範例 - 結算月結單

這個範例說明如何結算月結單。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 FinalizeInvoice 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
   }

如果動作成功，Finalize Invoice 工作的 connectorOutputPayload 回應參數會包含類似以下內容的值：

[{
"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,
}]

範例 - 確定報價

這個範例說明如何完成報價。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 FinalizeQuote 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
   }

如果動作成功，FinalizeQuote 工作的 connectorOutputPayload 回應參數會包含類似以下內容的值：

[{
"Success": "true"
}]

示例 - 接受報價

這個範例說明如何接受報價。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 AcceptQuote 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
   }

如果動作成功，AcceptQuote 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

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

範例 - 取消報價

以下範例說明如何取消報價。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CancelQuote 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
   }

如果動作成功，CancelQuote 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有顧客

這個範例會列出 Customer 實體中的所有客戶。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從「清單」Entity中選取 Customer。
3. 選取「List」作業，然後按一下「完成」。
4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句，篩選結果集。 請一律在單引號 (') 內指定篩選子句值。

範例 - 取得客戶記錄

這個範例會取得指定的客戶記錄。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「Get」作業，然後按一下「完成」。
4. 在「連線器」工作的「工作輸入」部分，按一下「EntityId」，然後在「預設值」欄位中輸入 cus_OxHsz0u5bCGWuy。

   其中 cus_OxHsz0u5bCGWuy 是 Customer 實體中的專屬記錄 ID。

範例 - 建立付款意圖

這個範例會在 PaymentIntent 實體中建立付款意圖。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 PaymentIntent。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

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

   如果整合成功，連接器工作的 connectorOutputPayload 回應參數值會類似以下內容：

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

範例 - 更新客戶記錄

這個範例會更新指定客戶的詳細資料。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Name": "John"
   }

5. 按一下「entityId」，然後在「Default Value」欄位中輸入 cus_OxHsz0u5bCGWuy。

   如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列的值：

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

範例 - 刪除客戶記錄

這個範例會從 Customer 實體中刪除指定客戶。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「Delete」作業，然後按一下「完成」。
4. 按一下「EntityId」，然後在「Default Value」欄位中輸入 cus_OxIqiMh1W335rE。