Stripe

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

  Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
  • List
  • Get
  • Create
  • Update
  • Delete

  Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Utiliser la connexion Stripe dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

• Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
• Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Actions

Cette section liste les actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action ConfirmPaymentIntent

Cette action confirme l'intent de paiement.

Paramètres d'entrée de l'action ConfirmPaymentIntent

Pour savoir comment configurer l'action ConfirmPaymentIntent, consultez Exemples d'actions.

Action CapturePaymentIntent

Cette action capture l'intent de paiement.

Paramètres d'entrée de l'action CapturePaymentIntent

Pour savoir comment configurer l'action ConfirmPaymentIntent, consultez Exemples d'actions.

Action CancelPaymentIntent

Cette action annule l'intent de paiement.

Paramètres d'entrée de l'action CancelPaymentIntent

Pour savoir comment configurer l'action CancelPaymentIntent, consultez Exemples d'actions.

Action AttachPaymentMethodToCustomer

Cette action associe un objet PaymentMethod à un client.

Paramètres d'entrée de l'action AttachPaymentMethodToCustomer

Pour savoir comment configurer l'action AttachPaymentMethodToCustomer, consultez Exemples d'actions.

Action DetachPaymentMethodFromCustomer

Cette action dissocie un objet PaymentMethod d'un client. Une fois qu'un objet PaymentMethod a été dissocié, vous ne pouvez plus l'associer au client.

Paramètres d'entrée de l'action DetachPaymentMethodFromCustomer

Pour savoir comment configurer l'action DetachPaymentMethodFromCustomer, consultez Exemples d'actions.

Action FinalizeInvoice

Cette action finalise le brouillon de la facture.

Paramètres d'entrée de l'action FinalizeInvoice

Pour savoir comment configurer l'action FinalizeInvoice, consultez Exemples d'actions.

Action FinalizeQuote

Cette action finalise le brouillon du devis.

Paramètres d'entrée de l'action FinalizeQuote

Pour savoir comment configurer l'action FinalizeQuote, consultez Exemples d'actions.

Action AcceptQuote

Cette action accepte le devis et génère une facture pour le devis accepté.

Paramètres d'entrée de l'action AcceptQuote

Pour savoir comment configurer l'action AcceptQuote, consultez Exemples d'actions.

Action CancelQuote

Cette action annule le brouillon d'un devis.

Paramètres d'entrée de l'action CancelQuote

Pour savoir comment configurer l'action CancelQuote, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Confirmer l'intent de paiement

Cet exemple montre comment confirmer l'intent du paiement spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action ConfirmPaymentIntent, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche ConfirmPaymentIntent aura une valeur semblable à la suivante :

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

Exemple : Capturer l'intent de paiement

Cet exemple montre comment capturer l'intent du paiement spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CapturePaymentIntent, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CapturePaymentIntent aura une valeur semblable à la suivante :

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

Exemple : Annuler un intent de paiement

Cet exemple montre comment annuler l'intent du paiement spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CancelPaymentIntent, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CancelPaymentIntent aura une valeur semblable à la suivante :

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

Exemple : Associer un mode de paiement à un client

Cet exemple montre comment associer un mode de paiement au client spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action AttachPaymentMethodToCustomer, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche AttachPaymentMethodToCustomer aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Dissocier un mode de paiement d'un client

Cet exemple montre comment dissocier un mode de paiement d'un client.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DetachPaymentMethodFromCustomer, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DetachPaymentMethodFromCustomer aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Finaliser une facture

Cet exemple montre comment finaliser une facture.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action FinalizeInvoice , puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Finalize Invoice aura une valeur semblable à la suivante :

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

Exemple : Finaliser un devis

Cet exemple montre comment finaliser un devis.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action FinalizeQuote, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche FinalizeQuote aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemple : Accepter un devis

Cet exemple montre comment accepter un devis.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action AcceptQuote, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche AcceptQuote aura une valeur semblable à la suivante :

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

Exemple : Annuler un devis

Cet exemple montre comment annuler un devis.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CancelQuote, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CancelQuote aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister tous les clients

Cet exemple liste tous les clients de l'entité Customer.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Customer dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Indiquez toujours la valeur de la clause de filtre entre guillemets simples (').

Exemple : Récupérer un enregistrement client

Cet exemple récupère l'enregistrement client spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Customer dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez cus_OxHsz0u5bCGWuy dans le champ Valeur par défaut.

   Ici, cus_OxHsz0u5bCGWuy est un ID d'enregistrement unique dans l'entité Customer.

Exemple : Créer un intent de paiement

Cet exemple crée un intent de paiement dans l'entité PaymentIntent.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez PaymentIntent dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

   Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

Exemple : Mettre à jour un enregistrement client

Cet exemple met à jour les informations du client spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Customer dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Name": "John"
   }

5. Cliquez sur EntityId, puis saisissez cus_OxHsz0u5bCGWuy dans le champ Valeur par défaut.

   Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

Exemple : Supprimer un enregistrement client

Cet exemple supprime le client spécifié de l'entité Customer.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Customer dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Cliquez sur EntityId, puis saisissez cus_OxIqiMh1W335rE dans le champ Valeur par défaut.