Documentação Experience Platform Guia dos conectores de origem

[Beta]{class="badge informative"}

Stripe

Last update: Tue Mar 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:
Sources

Criado para:

Developer

NOTE

A variável Stripe a fonte está na versão beta. Leia as visão geral das origens para obter mais informações sobre o uso de fontes rotuladas como beta.

Milhares de empresas de todos os tamanhos utilizam Stripe on-line e pessoalmente para aceitar pagamentos, gerar novas fontes de receita e expandir globalmente com a ajuda da Adobe Experience Platform, Adobe Commerce e Magento Open Source.

Use o Stripe origem no Experience Platform para assimilar dados capturados durante o fluxo de compra pelos clientes. Depois de assimilados, use esses dados para criar ofertas personalizadas e desbloquear insights de negócios mais avançados.

TIP

Para perguntas sobre o Stripe fonte no Experience Platform, contato Stripe na adobe-partner@stripe.com.

recommendation-more-help

Exemplo de caso de uso para o Stripe origem

Sua empresa permite que os clientes comprem itens em sua loja online com a opção de comprar agora e pagar mais tarde (usando Klarna, Afterpay, Affirmou Zip).

Use o Stripe fonte de dados para analisar o uso de comprar agora e pagar mais tarde e experimente ofertas personalizadas para esses clientes. Por exemplo, considere recomendar itens complementares para expandir o número de itens em seu carrinho de compras antes do check-out.

style

shade-box

Leia o documento abaixo para obter informações sobre como configurar seus Stripe , recupere as credenciais necessárias e crie seus esquemas.

Pré-requisitos prerequisites

As seções a seguir fornecem informações sobre a configuração de pré-requisitos que você deve concluir antes de conectar Stripe conta para Experience Platform.

Recupere o token de acesso

Faça logon no Stripe painel usar seu Stripe endereço de e-mail e senha.
No Developers painel, selecione API keys for developers.
No Chaves de API selecione Reveal test key para revelar seu token de acesso.
Agora você pode usar esse token como token de acesso ao conectar Stripe conta para Experience Platform, usando a variável Flow Service API ou a interface do Experience Platform.

Coletar credenciais necessárias

Para conectar seu Stripe conta para Experience Platform, você deve fornecer valores para as seguintes credenciais de autenticação:

API

Você deve fornecer as seguintes credenciais ao se conectar ao Stripe conta usando o Flow Service API.

table 0-row-2 1-row-2 2-row-2
Credencial	Descrição
`accessToken`	Seu Stripe Token de autenticação de código de atualização OAuth 2.
`connectionSpec.id`	A ID de especificação da conexão do Stripe origem. Essa ID é corrigida como: `cc2c31d6-7b8c-4581-b49f-5c8698aa3ab3`.

Interface do usuário

Você deve fornecer as seguintes credenciais ao se conectar ao Stripe usando a interface de usuário do Experience Platform.

table 0-row-2 1-row-2
Credencial	Descrição
Token de acesso	Seu Stripe Token de autenticação de código de atualização OAuth 2.

Para obter mais informações sobre o uso de Stripe APIs, leia as Stripe documentação sobre chaves de API.

Criar um esquema do Experience Data Model (XDM)

A variável Stripe A origem oferece suporte à assimilação de dados dos seguintes caminhos de recursos:

Encargos
Assinaturas
Reembolsos
Transações de Saldo
Clientes
Preços

É necessário criar um esquema XDM para descrever um conjunto de dados, que possa armazenar os campos e tipos de dados que serão enviados do Stripe para Experience Platform.

Encargos

Entrada Stripe, encargos representar tentativas de mover dinheiro para o seu Stripe. Leia o Stripe Guia de API sobre encargos para obter mais informações sobre atributos de encargo específicos.

accordion

Selecione para exibir o objeto Stripe Charge

code language-json

{
  "id": "ch_3MmlLrLkdIwHu7ix0snN0B15",
  "object": "charge",
  "amount": 1099,
  "amount_captured": 1099,
  "amount_refunded": 0,
  "application": null,
  "application_fee": null,
  "application_fee_amount": null,
  "balance_transaction": "txn_3MmlLrLkdIwHu7ix0uke3Ezy",
  "billing_details": {
    "address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "email": null,
    "name": null,
    "phone": null
  },
  "calculated_statement_descriptor": "Stripe",
  "captured": true,
  "created": 1679090539,
  "currency": "usd",
  "customer": null,
  "description": null,
  "disputed": false,
  "failure_balance_transaction": null,
  "failure_code": null,
  "failure_message": null,
  "fraud_details": {},
  "invoice": null,
  "livemode": false,
  "metadata": {},
  "on_behalf_of": null,
  "outcome": {
    "network_status": "approved_by_network",
    "reason": null,
    "risk_level": "normal",
    "risk_score": 32,
    "seller_message": "Payment complete.",
    "type": "authorized"
  },
  "paid": true,
  "payment_intent": null,
  "payment_method": "card_1MmlLrLkdIwHu7ixIJwEWSNR",
  "payment_method_details": {
    "card": {
      "brand": "visa",
      "checks": {
        "address_line1_check": null,
        "address_postal_code_check": null,
        "cvc_check": null
      },
      "country": "US",
      "exp_month": 3,
      "exp_year": 2024,
      "fingerprint": "mToisGZ01V71BCos",
      "funding": "credit",
      "installments": null,
      "last4": "4242",
      "mandate": null,
      "network": "visa",
      "three_d_secure": null,
      "wallet": null
    },
    "type": "card"
  },
  "receipt_email": null,
  "receipt_number": null,
  "receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xTTJKVGtMa2RJd0h1N2l4KOvG06AGMgZfBXyr1aw6LBa9vaaSRWU96d8qBwz9z2J_CObiV_H2-e8RezSK_sw0KISesp4czsOUlVKY",
  "refunded": false,
  "review": null,
  "shipping": null,
  "source_transfer": null,
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "succeeded",
  "transfer_data": null,
  "transfer_group": null
}

Subscrições

Entrada Stripe, você pode usar assinaturas para cobrar de forma recorrente de um cliente. Leia o Stripe Guia de API sobre assinaturas para obter mais informações sobre atributos de assinatura específicos.

accordion

Selecione para exibir o objeto de Assinatura do Stripe

code language-json

{
  "id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "object": "subscription",
  "application": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_cycle_anchor": 1679609767,
  "billing_thresholds": null,
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": null,
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": null
  },
  "collection_method": "charge_automatically",
  "created": 1679609767,
  "currency": "usd",
  "current_period_end": 1682288167,
  "current_period_start": 1679609767,
  "customer": "cus_Na6dX7aXxi11N4",
  "days_until_due": null,
  "default_payment_method": null,
  "default_source": null,
  "default_tax_rates": [],
  "description": null,
  "discount": null,
  "ended_at": null,
  "invoice_settings": {
    "issuer": {
      "type": "self"
    }
  },
  "items": {
    "object": "list",
    "data": [
      {
        "id": "si_Na6dzxczY5fwHx",
        "object": "subscription_item",
        "billing_thresholds": null,
        "created": 1679609768,
        "metadata": {},
        "plan": {
          "id": "price_1MowQULkdIwHu7ixraBm864M",
          "object": "plan",
          "active": true,
          "aggregate_usage": null,
          "amount": 1000,
          "amount_decimal": "1000",
          "billing_scheme": "per_unit",
          "created": 1679609766,
          "currency": "usd",
          "interval": "month",
          "interval_count": 1,
          "livemode": false,
          "metadata": {},
          "nickname": null,
          "product": "prod_Na6dGcTsmU0I4R",
          "tiers_mode": null,
          "transform_usage": null,
          "trial_period_days": null,
          "usage_type": "licensed"
        },
        "price": {
          "id": "price_1MowQULkdIwHu7ixraBm864M",
          "object": "price",
          "active": true,
          "billing_scheme": "per_unit",
          "created": 1679609766,
          "currency": "usd",
          "custom_unit_amount": null,
          "livemode": false,
          "lookup_key": null,
          "metadata": {},
          "nickname": null,
          "product": "prod_Na6dGcTsmU0I4R",
          "recurring": {
            "aggregate_usage": null,
            "interval": "month",
            "interval_count": 1,
            "trial_period_days": null,
            "usage_type": "licensed"
          },
          "tax_behavior": "unspecified",
          "tiers_mode": null,
          "transform_quantity": null,
          "type": "recurring",
          "unit_amount": 1000,
          "unit_amount_decimal": "1000"
        },
        "quantity": 1,
        "subscription": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
        "tax_rates": []
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/v1/subscription_items?subscription=sub_1MowQVLkdIwHu7ixeRlqHVzs"
  },
  "latest_invoice": "in_1MowQWLkdIwHu7ixuzkSPfKd",
  "livemode": false,
  "metadata": {},
  "next_pending_invoice_item_invoice": null,
  "on_behalf_of": null,
  "pause_collection": null,
  "payment_settings": {
    "payment_method_options": null,
    "payment_method_types": null,
    "save_default_payment_method": "off"
  },
  "pending_invoice_item_interval": null,
  "pending_setup_intent": null,
  "pending_update": null,
  "quantity": 1,
  "schedule": null,
  "start_date": 1679609767,
  "status": "active",
  "test_clock": null,
  "transfer_data": null,
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null
}

Reembolsos

Entrada Stripe, você pode usar reembolsos para reembolsar um encargo criado anteriormente. Leia o Stripe Guia de API sobre reembolsos para obter mais informações sobre atributos de restituição específicos.

accordion

Selecione para exibir o objeto Reembolso de Stripe

code language-json

{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {},
  "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": null
}

Transações de Saldo

Entrada Stripe, transações de saldo representam o movimento de fundos entre as Stripe contas. Leia o Stripe Guia de API sobre transações de saldo para obter mais informações sobre atributos de transação de saldo específicos.

accordion

Selecione para exibir o objeto Transação de Saldo de Stripe

code language-json

{
  "id": "txn_1MiN3gLkdIwHu7ixxapQrznl",
  "object": "balance_transaction",
  "amount": -400,
  "available_on": 1678043844,
  "created": 1678043844,
  "currency": "usd",
  "description": null,
  "exchange_rate": null,
  "fee": 0,
  "fee_details": [],
  "net": -400,
  "reporting_category": "transfer",
  "source": "tr_1MiN3gLkdIwHu7ixNCZvFdgA",
  "status": "available",
  "type": "transfer"
}

Clientes

Entrada Stripe, clientes representa um determinado cliente da sua empresa. Para obter informações sobre atributos específicos do cliente, leia o Stripe Guia de API sobre clientes para obter mais informações sobre atributos específicos do cliente.

accordion

Selecione para exibir o objeto Stripe Customer

code language-json

{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "discount": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {},
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}

Preços

Entrada Stripe, preços representa o custo unitário, a moeda e o ciclo de faturamento opcional para compra recorrente e única de produtos. Leia o Stripe Guia de API sobre preços para obter mais informações sobre atributos de preço específicos.

accordion

Selecione para exibir o objeto Preço do Stripe

code language-json

{
  "id": "price_1MoBy5LkdIwHu7ixZhnattbh",
  "object": "price",
  "active": true,
  "billing_scheme": "per_unit",
  "created": 1679431181,
  "currency": "usd",
  "custom_unit_amount": null,
  "livemode": false,
  "lookup_key": null,
  "metadata": {},
  "nickname": null,
  "product": "prod_NZKdYqrwEYx6iK",
  "recurring": {
    "aggregate_usage": null,
    "interval": "month",
    "interval_count": 1,
    "trial_period_days": null,
    "usage_type": "licensed"
  },
  "tax_behavior": "unspecified",
  "tiers_mode": null,
  "transform_quantity": null,
  "type": "recurring",
  "unit_amount": 1000,
  "unit_amount_decimal": "1000"
}

LISTA DE PERMISSÕES de endereço IP

Uma lista de endereços IP deve ser adicionada a uma lista de permissões antes de trabalhar com conectores de origem. Falha ao adicionar endereços IP específicos da região à lista de permissões pode levar a erros ou ao não desempenho ao usar origens. Consulte a LISTA DE PERMISSÕES de endereço IP para obter mais informações.

Configurar permissões no Experience Platform

Você deve ter ambos Exibir fontes e Gerenciar fontes permissões habilitadas para sua conta para conectar seu Stripe conta para Experience Platform. Entre em contato com o administrador do produto para obter as permissões necessárias. Para obter mais informações, leia a guia da interface do usuário de controle de acesso.

Próximas etapas

Após concluir a configuração de pré-requisito, você pode prosseguir para conectar e assimilar seus Stripe dados para Experience Platform. Leia os guias a seguir para saber como assimilar Stripe dados de pagamentos para o Experience Platform usando APIs ou a interface do usuário:

337b99bb-92fb-42ae-b6b7-c7042161d089