View a markdown version of this page

Stripe connector for Amazon AppFlow - Amazon AppFlow

Stripe connector for Amazon AppFlow

Stripe powers ecommerce with payment processing and other commerce solutions for businesses. If you're a Stripe user, your account contains data about your transactions, such as your balance, charges, and payouts. You can use Amazon AppFlow to transfer data from Stripe to certain AWS services or other supported applications.

Amazon AppFlow support for Stripe

Amazon AppFlow supports Stripe as follows.

Supported as a data source?

Yes. You can use Amazon AppFlow to transfer data from Stripe.

Supported as a data destination?

No. You can't use Amazon AppFlow to transfer data to Stripe.

Before you begin

Before you can use Amazon AppFlow to transfer data from Stripe, you must have a Stripe account that contains the data to transfer. For more information about the Stripe data objects that Amazon AppFlow supports, see Supported objects.

From your Stripe account, you must obtain a test or live API key. You provide this key to Amazon AppFlow when you connect to your Stripe account. For the steps to obtain these keys, see Manage API keys in the Stripe Docs.

Connecting Amazon AppFlow to your Stripe account

To connect Amazon AppFlow to your Stripe account, provide your API key so that Amazon AppFlow can access your data. If you haven't yet configured your Stripe account for Amazon AppFlow integration, see Before you begin.

To connect to Stripe
  1. Sign in to the AWS Management Console and open the Amazon AppFlow console at https://console.aws.amazon.com/appflow/.

  2. In the navigation pane on the left, choose Connections.

  3. On the Manage connections page, for Connectors, choose Stripe.

  4. Choose Create connection.

  5. In the Connect to Stripe window, for API Key, enter a test or live API key from your Stripe account settings.

  6. Optionally, under Data encryption, choose Customize encryption settings (advanced) if you want to encrypt your data with a customer managed key in the AWS Key Management Service (AWS KMS).

    By default, Amazon AppFlow encrypts your data with a KMS key that AWS creates, uses, and manages for you. Choose this option if you want to encrypt your data with your own KMS key instead.

    Amazon AppFlow always encrypts your data during transit and at rest. For more information, see Data protection in Amazon AppFlow.

    If you want to use a KMS key from the current AWS account, select this key under Choose an AWS KMS key. If you want to use a KMS key from a different AWS account, enter the Amazon Resource Name (ARN) for that key.

  7. For Connection name, enter a name for your connection.

  8. Choose Connect.

On the Manage connections page, your new connection appears in the Connections table. When you create a flow that uses Stripe as the data source, you can select this connection.

Transferring data from Stripe with a flow

To transfer data from Stripe, create an Amazon AppFlow flow, and choose Stripe as the data source. For the steps to create a flow, see Creating flows in Amazon AppFlow.

When you configure the flow, choose the data object that you want to transfer. For the objects that Amazon AppFlow supports for Stripe, see Supported objects.

Also, choose the destination where you want to transfer the data object that you selected. For more information about how to configure your destination, see Supported destinations.

Supported destinations

When you create a flow that uses Stripe as the data source, you can set the destination to any of the following connectors:

Supported objects

When you create a flow that uses Stripe as the data source, you can transfer any of the following data objects to supported destinations:

Object

Field

Data type

Supported filters

Account

business_profile

Struct

capabilities

Struct

charges_enabled

Boolean

controller

Struct

country

String

created

DateTime

EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO

default_currency

String

details_submitted

Boolean

email

String

external_account

Struct

future_requirements

Struct

id

Integer

metadata

Struct

object

String

payouts_enabled

Boolean

requirements

Struct

settings

Struct

type

String

Application Fee

account

String

amount

Integer

EQUAL_TO

amount_refunded

Integer

EQUAL_TO

application

String

balance_transaction

String

charge

String

EQUAL_TO

created

DateTime

EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO

currency

String

id

String

livemode

Boolean

object

String

originating_transaction

String

refunded

Boolean

EQUAL_TO

refunds

List

Balance

amount

Integer

currency

String

source_types

Struct

Balance Transaction

amount

Integer

available_on

DateTime

EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO

created

DateTime

EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO

currency

String

description

String

exchange_rate

Double

fee

Integer

fee_details

List

id

String

net

Integer

object

String

reporting_category

String

source

String

EQUAL_TO

status

String

type

String

EQUAL_TO

Charge

amount

Integer

EQUAL_TO

amount_captured

Integer

amount_refunded

Integer

application

String

application_fee

String

application_fee_amount

Integer

balance_transaction

String

billing_details

Struct

calculated_statement_descriptor

String

captured

Boolean

created

DateTime

EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO

currency

String

customer

String

EQUAL_TO

description

String

destination

String

dispute

String

disputed

Boolean

EQUAL_TO

failure_balance_transaction

String

failure_code

String

failure_message

String

fraud_details

Struct

id

String

invoice

String

livemode

Boolean

metadata

Struct

object

String

on_behalf_of

String

order

String

outcome

Struct

paid

Boolean

payment_intent

String

EQUAL_TO

payment_method

String

payment_method_details

Struct

receipt_email

String

receipt_number

String

receipt_url

String

refunded

Boolean

EQUAL_TO

refunds

Struct

review

String

shipping

Struct

source

String

source_transfer

String

statement_descriptor

String

statement_descriptor_suffix

String

status

String

transfer_data

Struct

transfer_group

String

EQUAL_TO

Country Spec

default_currency

String

id

String

object

String

supported_bank_account_currencies

Struct

supported_payment_currencies

List

supported_payment_methods

List

supported_transfer_countries

List

verification_fields

Struct

Coupon

amount_off

Integer

created

DateTime

EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO

currency

String

EQUAL_TO

duration

String

EQUAL_TO

duration_in_months

Integer

EQUAL_TO

id

String

livemode

Boolean

max_redemptions

Integer