The Shared Payment Issued Token object

Attributes

• id string Unique identifier for the object.
• object string, value is "shared_payment.issued_token" 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 nullable timestamp Time at which this SharedPaymentIssuedToken was deactivated.
• deactivated _ reason nullable enum 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 nullable object If present, describes the action required to make this SharedPaymentIssuedToken usable for payments. Present when the token is in requires_action state.
• payment _ method string ID of an existing PaymentMethod.
• risk _ details nullable object Risk details of the SharedPaymentIssuedToken.
• seller _ details nullable object Seller details of the SharedPaymentIssuedToken, including network_id and external_id.
• setup _ future _ usage nullable enum 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 nullable map Metadata about the SharedPaymentIssuedToken.
• status nullable enum 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 nullable object Usage details of the SharedPaymentIssuedToken
• usage _ limits nullable object Usage limits of the SharedPaymentIssuedToken.
• use _ stripe _ sdk nullable boolean Set to true when using Stripe.js, iOS, or Android client-side SDKs to handle next actions.

The Shared Payment Issued Token object

{ "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": null, "network_business_profile": "profile_test_61TU90nIeGjU7NNVXA6TU90m7ISQWsBxpcx9lASWWXTk" }, "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 }}

Create a SharedPaymentIssuedToken

POST / v1 / shared_payment / issued_tokens

Creates a new SharedPaymentIssuedToken object

Parameters

• payment _ method string Required The PaymentMethod that is going to be shared by the SharedPaymentIssuedToken.
• seller _ details object Required Seller details of the SharedPaymentIssuedToken, including network_id and external_id.
• usage _ limits object Required Limits on how this SharedPaymentToken can be used.
• setup _ future _ usage enum 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 map Set of key-value pairs that you can attach to the SharedPaymentIssuedToken. The values here are visible by default with the party that you share this SharedPaymentIssuedToken with.

Returns

Returns the newly created SharedPaymentIssuedToken

Response

{ "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": null, "network_business_profile": "profile_test_61TU90nIeGjU7NNVXA6TU90m7ISQWsBxpcx9lASWWXTk" }, "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 }}

Retrieve a SharedPaymentIssuedToken

GET / v1 / shared_payment / issued_tokens /:id

Retrieves an existing SharedPaymentIssuedToken object

Parameters

No parameters.

Returns

Returns the specified SharedPaymentIssuedToken

Response

{ "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": null, "network_business_profile": "profile_test_61TU90nIeGjU7NNVXA6TU90m7ISQWsBxpcx9lASWWXTk" }, "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 }}