Stripe

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Use the Stripe connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
• To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

ConfirmPaymentIntent action

This action lets you confirm the payment intent.

Input parameters of the ConfirmPaymentIntent action

For example on how to configure the ConfirmPaymentIntent action, see Action examples.

CapturePaymentIntent action

This action lets you capture the payment intent.

Input parameters of the CapturePaymentIntent action

For example on how to configure the ConfirmPaymentIntent action, see Action examples.

CancelPaymentIntent action

This action lets you cancel the payment intent.

Input parameters of the CancelPaymentIntent action

For example on how to configure the CancelPaymentIntent action, see Action examples.

AttachPaymentMethodToCustomer action

This action lets you attach a PaymentMethod object to a Customer.

Input parameters of the AttachPaymentMethodToCustomer action

For example on how to configure the AttachPaymentMethodToCustomer action, see Action examples.

DetachPaymentMethodFromCustomer action

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

Input parameters of the DetachPaymentMethodFromCustomer action

For example on how to configure the DetachPaymentMethodFromCustomer action, see Action examples.

FinalizeInvoice action

To finalize the draft Invoice.

Input parameters of the Finalize Invoice action

For example on how to configure the FinalizeInvoice action, see Action examples.

FinalizeQuote action

To finalize the drafted quote.

Input parameters of the FinalizeQuote action

For example on how to configure the FinalizeQuote action, see Action examples.

AcceptQuote action

This action lets you to accept the quote and generate the Invoice for the accepted quote.

Input parameters of the AcceptQuote action

For example on how to configure the AcceptQuote action, see Action examples.

CancelQuote action

This action lets you To cancel the drafted quote.

Input parameters of the CancelQuote action

For example on how to configure the CancelQuote action, see Action examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Confirm payment intent

This example shows how to confirm the intent of the specified payment.

1. In the Configure connector task dialog, click Actions.
2. Select the ConfirmPaymentIntent action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the ConfirmPaymentIntent task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Capture payment intent

This example shows how to capture the intent of the specified payment.

1. In the Configure connector task dialog, click Actions.
2. Select the CapturePaymentIntent action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
   }

If the action is successful, the CapturePaymentIntent task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Cancel payment intent

This example shows how to cancel the intent of the specified payment.

1. In the Configure connector task dialog, click Actions.
2. Select the CancelPaymentIntent action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
   }

If the action is successful, the CancelPaymentIntent task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Attach payment method to a customer

This example shows how to attached a payment method to the specified customer.

1. In the Configure connector task dialog, click Actions.
2. Select the AttachPaymentMethodToCustomer action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the AttachPaymentMethodToCustomer task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Detach payment method from a customer

This example shows how to detach payment method from a customer.

1. In the Configure connector task dialog, click Actions.
2. Select the DetachPaymentMethodFromCustomer action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
   }

If the action is successful, the DetachPaymentMethodFromCustomer task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Finalize an invoice

This example shows how to finalize an invoice.

1. In the Configure connector task dialog, click Actions.
2. Select the FinalizeInvoice action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
   }

If the action is successful, the Finalize Invoice task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Finalize a quote

This example shows how to finalize a quote.

1. In the Configure connector task dialog, click Actions.
2. Select the FinalizeQuote action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
   }

If the action is successful, the FinalizeQuote task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Accept a quote

This example shows how to accept a quote.

1. In the Configure connector task dialog, click Actions.
2. Select the AcceptQuote action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
   }

If the action is successful, the AcceptQuote task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Cancel a quote

This example shows how to cancel a quote.

1. In the Configure connector task dialog, click Actions.
2. Select the CancelQuote action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
   }

If the action is successful, the CancelQuote task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all customers

This example lists all the customers in the Customer entity.

1. In the Configure connector task dialog, click Entities.
2. Select Customer from the Entity List.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').
.

Example - Get a customer record

This example gets the specified customer record.

1. In the Configure connector task dialog, click Entities.
2. Select Customer from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter cus_OxHsz0u5bCGWuy in the Default Value field.

   Here, cus_OxHsz0u5bCGWuy is a unique record ID in the Customer entity.

Example - Create a payment intent

This example creates a payment intent in the PaymentIntent entity.

1. In the Configure connector task dialog, click Entities.
2. Select PaymentIntent from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

   If the integration is successful, your connector task's connectorOutputPayload response parameter will have a value similar to the following:

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

Example - Update a customer record

This example updates the details of the specified customer.

1. In the Configure connector task dialog, click Entities.
2. Select Customer from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "Name": "John"
   }

5. Click entityId, and then enter cus_OxHsz0u5bCGWuy in the Default Value field.

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

Example - Delete a customer record

This example deletes the specified customer from the Customer entity.

1. In the Configure connector task dialog, click Entities.
2. Select Customer from the Entity list.
3. Select the Delete operation, and then click Done.
4. Click EntityId and then enter cus_OxIqiMh1W335rE in the Default Value field.