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 }}

Create a test SharedPaymentGrantedToken Test helper

POST / v1 / test_helpers / shared_payment / granted_tokens

Creates a new test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to create SharedPaymentGrantedTokens for testing their integration

Parameters

• payment _ method string Required The PaymentMethod that is going to be shared by the SharedPaymentGrantedToken.
• usage _ limits object Required Limits on how this SharedPaymentGrantedToken can be used.
• customer string The Customer that the SharedPaymentGrantedToken belongs to. Should match the Customer that the PaymentMethod is attached to if any.
• shared _ metadata map Set of key-value pairs that you can attach to the SharedPaymentGrantedToken.

Returns

Returns the newly created 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 }}

Revoke a test SharedPaymentGrantedToken Test helper

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

Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration

Parameters

No parameters.

Returns

Returns the revoked SharedPaymentGrantedToken

Response

{ "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q", "object": "shared_payment.granted_token", "agent_details": { "network_business_profile": "profile_test_61U92KWAstyE3VYhXA6U91t01FSQ3ByrZzKJOCR0y5ey" }, "created": 1751500820, "deactivated_at": 1751587220, "deactivated_reason": "revoked", "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 }}