Stripe

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene mostrata come entità, operazioni e azioni.

• Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio connesso. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore del file server, le cartelle sono le entità e in un connettore del sistema di messaggistica, le code sono le entità.

  Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

• Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

• Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Utilizzare la connessione Stripe in un'integrazione

Una volta creata la connessione, questa diventa disponibile sia in Apigee Integration che in Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

• Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
• Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Azioni

Questa sezione elenca le azioni supportate dal connettore. Per capire come configurare le azioni, consulta Esempi di azioni.

Azione ConfirmPaymentIntent

Questa azione conferma l'intenzione di pagamento.

Parametri di input dell'azione ConfirmPaymentIntent

Per un esempio di come configurare l'azione ConfirmPaymentIntent, consulta Esempi di azioni.

Azione CapturePaymentIntent

Questa azione acquisisce l'intent di pagamento.

Parametri di input dell'azione CapturePaymentIntent

Per un esempio di come configurare l'azione ConfirmPaymentIntent, consulta Esempi di azioni.

Azione CancelPaymentIntent

Questa azione annulla l'intent di pagamento.

Parametri di input dell'azione CancelPaymentIntent

Per un esempio di come configurare l'azione CancelPaymentIntent, consulta Esempi di azioni.

Azione AttachPaymentMethodToCustomer

Questa azione associa un oggetto PaymentMethod a un cliente.

Parametri di input dell'azione AttachPaymentMethodToCustomer

Per un esempio di come configurare l'azione AttachPaymentMethodToCustomer, consulta Esempi di azioni.

Azione DetachPaymentMethodFromCustomer

Questa azione scollega un oggetto PaymentMethod da un cliente. Una volta scollegato un PaymentMethod, non puoi ricollegarlo al cliente.

Parametri di input dell'azione DetachPaymentMethodFromCustomer

Per un esempio di come configurare l'azione DetachPaymentMethodFromCustomer, consulta Esempi di azioni.

Azione FinalizeInvoice

Questa azione finalizza la bozza di fattura.

Parametri di input dell'azione Finalizza fattura

Per un esempio di come configurare l'azione FinalizeInvoice, consulta Esempi di azioni.

Azione FinalizeQuote

Questa azione finalizza il preventivo in bozza.

Parametri di input dell'azione FinalizeQuote

Per un esempio di come configurare l'azione FinalizeQuote, consulta Esempi di azioni.

Azione AcceptQuote

Questa azione accetta il preventivo e genera una fattura per il preventivo accettato.

Parametri di input dell'azione AcceptQuote

Per un esempio di come configurare l'azione AcceptQuote, consulta Esempi di azioni.

Azione CancelQuote

Questa azione annulla il preventivo in bozza.

Parametri di input dell'azione CancelQuote

Per un esempio di come configurare l'azione CancelQuote, consulta Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: conferma dell'intent di pagamento

Questo esempio mostra come confermare l'intento del pagamento specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione ConfirmPaymentIntent, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro connectorOutputPayload della risposta ConfirmPaymentIntent dell'attività avrà un valore simile al seguente:

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

Esempio: acquisisci l'intent di pagamento

Questo esempio mostra come acquisire l'intento del pagamento specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CapturePaymentIntent, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
   }

Se l'azione ha esito positivo, il parametro CapturePaymentIntent della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: annullamento dell'intent di pagamento

Questo esempio mostra come annullare l'intenzione del pagamento specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CancelPaymentIntent, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
   }

Se l'azione ha esito positivo, il parametro CancelPaymentIntent della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: collegare un metodo di pagamento a un cliente

Questo esempio mostra come collegare un metodo di pagamento al cliente specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione AttachPaymentMethodToCustomer, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

Se l'azione ha esito positivo, il parametro AttachPaymentMethodToCustomer della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: stacca il metodo di pagamento da un cliente

Questo esempio mostra come scollegare un metodo di pagamento da un cliente.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione DetachPaymentMethodFromCustomer, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
   }

Se l'azione ha esito positivo, il parametro DetachPaymentMethodFromCustomer della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: finalizzare una fattura

Questo esempio mostra come finalizzare una fattura.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione FinalizeInvoice , quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività Finalize Invoice avrà un valore simile al seguente:

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

Esempio: finalizzare un preventivo

Questo esempio mostra come finalizzare un preventivo.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione FinalizeQuote, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
   }

Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività FinalizeQuote avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempio: accettare un preventivo

Questo esempio mostra come accettare un preventivo.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione AcceptQuote, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
   }

Se l'azione ha esito positivo, il parametro AcceptQuote della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

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

Esempio: annullare un preventivo

Questo esempio mostra come annullare un preventivo.

1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
2. Seleziona l'azione CancelQuote, quindi fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
   }

Se l'azione ha esito positivo, il parametro CancelQuote della risposta connectorOutputPayload dell'attività avrà un valore simile al seguente:

[{
"Success": "true"
}]

Esempi di operazioni sulle entità

Questa sezione mostra come eseguire alcune delle operazioni sulle entità in questo connettore.

Esempio: elenca tutti i clienti

Questo esempio elenca tutti i clienti nell'entità Customer.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Customer dall'elenco Entity.
3. Seleziona l'operazione List, quindi fai clic su Fine.
4. (Facoltativo) Nella sezione Input attività dell'attività Connettori, puoi filtrare il set di risultati specificando una clausola di filtro. Specifica il valore della clausola di filtro sempre tra virgolette singole (').

Esempio: recuperare un record cliente

Questo esempio recupera il record del cliente specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Customer dall'elenco Entity.
3. Seleziona l'operazione Get, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e poi inserisci cus_OxHsz0u5bCGWuy nel campo Valore predefinito.

   In questo caso, cus_OxHsz0u5bCGWuy è un ID record univoco nell'entità Customer.

Esempio: creare un intent di pagamento

Questo esempio crea un intent di pagamento nell'entità PaymentIntent.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona PaymentIntent dall'elenco Entity.
3. Seleziona l'operazione Create, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

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

   Se l'integrazione va a buon fine, il parametro connectorOutputPayload response dell'attività del connettore avrà un valore simile al seguente:

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

Esempio: aggiornare un record cliente

Questo esempio aggiorna i dettagli del cliente specificato.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Customer dall'elenco Entity.
3. Seleziona l'operazione Update, quindi fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:

   {
   "Name": "John"
   }

5. Fai clic su entityId, quindi inserisci cus_OxHsz0u5bCGWuy nel campo Valore predefinito.

   Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

Esempio: elimina un record cliente

Questo esempio elimina il cliente specificato dall'entità Customer.

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Customer dall'elenco Entity.
3. Seleziona l'operazione Delete, quindi fai clic su Fine.
4. Fai clic su EntityId e poi inserisci cus_OxIqiMh1W335rE nel campo Valore predefinito.