# The Shared Payment Issued Token object

## Attributes

- `id` (string)
  Unique identifier for the object.

- `object` (string)
  String representing the object’s type. Objects of the same type share the same value.

- `created` (timestamp)
  Time at which the object was created. Measured in seconds since the Unix epoch.

- `deactivated_at` (timestamp, nullable)
  Time at which this SharedPaymentIssuedToken was deactivated.

- `deactivated_reason` (enum, nullable)
  The reason why the SharedPaymentIssuedToken has been deactivated.
Possible enum values:
  - `consumed`
    `consumed` indicates that this token has been consumed due to hitting the allowed amount limit.

  - `expired`
    `expired` indicates that this token has expired.

  - `resolved`
    `resolved` indicates that this token has been resolved by a seller.

  - `revoked`
    `revoked` indicates that this token has been revoked by the issuer.

- `livemode` (boolean)
  If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.

- `next_action` (object, nullable)
  If present, describes the action required to make this `SharedPaymentIssuedToken` usable for payments. Present when the token is in `requires_action` state.

  - `next_action.type` (enum)
    Specifies the type of next action required. Determines which child attribute contains action details.
Possible enum values:
    - `use_stripe_sdk`
      Indicates that the next action requires Stripe.js, iOS, or Android SDKs.

  - `next_action.use_stripe_sdk` (object, nullable)
    Contains details for handling the next action using Stripe.js, iOS, or Android SDKs. Present when `next_action.type` is `use_stripe_sdk`.

    - `next_action.use_stripe_sdk.value` (string)
      A base64-encoded string used by Stripe.js and the iOS and Android client SDKs to handle the next action. Its content is subject to change.

- `payment_method` (string)
  ID of an existing PaymentMethod.

- `risk_details` (object, nullable)
  Risk details of the SharedPaymentIssuedToken.

  - `risk_details.insights` (object)
    Risk insights for this token, including scores and recommended actions for each risk type.

    - `risk_details.insights.bot` (object, nullable)
      Bot risk insight.

      - `risk_details.insights.bot.recommended_action` (string)
        Recommended action for this insight.

      - `risk_details.insights.bot.score` (float)
        Risk score for this insight.

    - `risk_details.insights.card_issuer_decline` (object, nullable)
      Card issuer decline risk insight.

      - `risk_details.insights.card_issuer_decline.recommended_action` (string)
        Recommended action for this insight.

      - `risk_details.insights.card_issuer_decline.score` (float)
        Risk score for this insight.

    - `risk_details.insights.card_testing` (object, nullable)
      Card testing risk insight.

      - `risk_details.insights.card_testing.recommended_action` (string)
        Recommended action for this insight.

      - `risk_details.insights.card_testing.score` (float)
        Risk score for this insight.

    - `risk_details.insights.fraudulent_dispute` (object, nullable)
      Fraudulent dispute risk insight.

      - `risk_details.insights.fraudulent_dispute.recommended_action` (string)
        Recommended action for this insight.

      - `risk_details.insights.fraudulent_dispute.score` (integer)
        Risk score for this insight.

    - `risk_details.insights.stolen_card` (object, nullable)
      Stolen card risk insight.

      - `risk_details.insights.stolen_card.recommended_action` (string)
        Recommended action for this insight.

      - `risk_details.insights.stolen_card.score` (integer)
        Risk score for this insight.

- `seller_details` (object, nullable)
  Seller details of the SharedPaymentIssuedToken, including network_id and external_id.

  - `seller_details.external_id` (string)
    A unique id within a network that identifies a logical seller. This should usually be the merchant id on the seller platform.

  - `seller_details.network_business_profile` (string)
    The unique and logical string that identifies the seller platform that this SharedToken is being created for.

- `setup_future_usage` (enum, nullable)
  Indicates that you intend to save the PaymentMethod of this SharedPaymentToken to a customer later.
Possible enum values:
  - `on_session`
    Use `on_session` to reuse the payment method when your customer is present in the checkout flow.

- `shared_metadata` (object, nullable)
  Metadata about the SharedPaymentIssuedToken.

- `status` (enum, nullable)
  Status of this SharedPaymentIssuedToken, one of `active`, `requires_action`, or `deactivated`.
Possible enum values:
  - `active`
    `active` indicates that this SharedPaymentIssuedToken is currently active and usable.

  - `deactivated`
    `deactivated` indicates that this SharedPaymentIssuedToken has been deactivated.

  - `requires_action`
    `requires_action` indicates that this SharedPaymentIssuedToken requires additional action from the customer before it can be used.

- `usage_details` (object, nullable)
  Usage details of the SharedPaymentIssuedToken

  - `usage_details.amount_captured` (object, nullable)
    The total amount captured using this SharedPaymentToken.

    - `usage_details.amount_captured.currency` (enum)
      Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

    - `usage_details.amount_captured.value` (integer)
      Integer value of the amount in the smallest currency unit.

- `usage_limits` (object, nullable)
  Usage limits of the SharedPaymentIssuedToken.

  - `usage_limits.currency` (string)
    Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

  - `usage_limits.expires_at` (timestamp, nullable)
    Time at which this SharedPaymentToken expires and can no longer be used to confirm a PaymentIntent.

  - `usage_limits.max_amount` (integer)
    Max amount that can be captured using this SharedPaymentToken.

### The Shared Payment Issued Token object

```json
{
  "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q",
  "object": "shared_payment.issued_token",
  "livemode": false,
  "created": 1751500820,
  "deactivated_at": null,
  "deactivated_reason": null,
  "payment_method": "pm_1RgaZbFPC5QUO6ZCe2ekOCNX",
  "seller_details": {
    "external_id": "{{EXTERNAL_ID}}",
    "network_business_profile": "{{NETWORK_BUSINESS_PROFILE}}"
  },
  "setup_future_usage": null,
  "shared_metadata": {},
  "status": "active",
  "usage_details": {
    "amount_captured": {
      "value": 0,
      "currency": "usd"
    }
  },
  "usage_limits": {
    "currency": "usd",
    "expires_at": 1751587220,
    "max_amount": 1000
  }
}
```