Shared Payment Granted Tokens

SharedPaymentGrantedToken is the view-only resource of a SharedPaymentIssuedToken, which is a limited-use reference to a PaymentMethod. When another Stripe merchant shares a SharedPaymentIssuedToken with you, you can view attributes of the shared token using the SharedPaymentGrantedToken API, and use it with a PaymentIntent.

Was this section helpful? Yes No

Retrieve a SharedPaymentGrantedToken

GET / v1 / shared_payment / granted_tokens /:id

Create a test SharedPaymentGrantedToken

POST / v1 / test_helpers / shared_payment / granted_tokens

Revoke a test SharedPaymentGrantedToken

POST / v1 / test_helpers / shared_payment / granted_tokens /:id / revoke

The Shared Payment Granted Token object

Attributes

• id string Unique identifier for the object.
• object string, value is "shared_payment.granted_token" String representing the object’s type. Objects of the same type share the same value.
• agent _ details nullable object Details about the agent that issued this SharedPaymentGrantedToken.
• created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
• deactivated _ at nullable timestamp Time at which this SharedPaymentGrantedToken expires and can no longer be used to confirm a PaymentIntent.
• deactivated _ reason nullable enum The reason why the SharedPaymentGrantedToken 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.
• payment _ method _ details nullable object Details of the PaymentMethod that was shared via this token.
• risk _ details nullable object Risk details of the SharedPaymentGrantedToken.
• shared _ metadata nullable map Metadata about the SharedPaymentGrantedToken.
• usage _ details nullable object Some details about how the SharedPaymentGrantedToken has been used already.
• usage _ limits nullable object Limits on how this SharedPaymentGrantedToken can be used.

The Shared Payment Granted Token object

{ "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q", "object": "shared_payment.granted_token", "agent_details": { "network_business_profile": "profile_test_61U92KWAstyE3VYhXA6U91t01FSQ3ByrZzKJOCR0y5ey" }, "created": 1751500820, "deactivated_at": null, "deactivated_reason": null, "livemode": false, "payment_method_details": { "type": "card", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "John Doe", "phone": null }, "card": { "brand": "visa", "country": "US", "display_brand": "visa", "exp_month": 9, "exp_year": 2029, "fingerprint": "dyRcYjZNxnHpC51l", "funding": "credit", "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "wallet": null } }, "shared_metadata": {}, "usage_details": { "amount_captured": { "value": 0, "currency": "usd" } }, "usage_limits": { "currency": "usd", "expires_at": 1751587220, "max_amount": 1000 }}

Retrieve a SharedPaymentGrantedToken

GET / v1 / shared_payment / granted_tokens /:id

Retrieves an existing SharedPaymentGrantedToken object

Parameters

No parameters.

Returns

Returns the specified SharedPaymentGrantedToken

Response

{ "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q", "object": "shared_payment.granted_token", "agent_details": { "network_business_profile": "profile_test_61U92KWAstyE3VYhXA6U91t01FSQ3ByrZzKJOCR0y5ey" }, "created": 1751500820, "deactivated_at": null, "deactivated_reason": null, "livemode": false, "payment_method_details": { "type": "card", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "John Doe", "phone": null }, "card": { "brand": "visa", "country": "US", "display_brand": "visa", "exp_month": 9, "exp_year": 2029, "fingerprint": "dyRcYjZNxnHpC51l", "funding": "credit", "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "wallet": null } }, "shared_metadata": {}, "usage_details": { "amount_captured": { "value": 0, "currency": "usd" } }, "usage_limits": { "currency": "usd", "expires_at": 1751587220, "max_amount": 1000 }}