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_sessionUseon_sessionto 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 }}
Revoke a SharedPaymentIssuedToken
POST / v1 / shared_payment / issued_tokens /:id / revoke
Revokes a SharedPaymentIssuedToken
Parameters
No parameters.
Returns
Returns the revoked SharedPaymentIssuedToken
Response
{ "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q", "object": "shared_payment.issued_token", "livemode": false, "created": 1751500820, "deactivated_at": 1751587220, "deactivated_reason": "revoked", "payment_method": "pm_1RgaZbFPC5QUO6ZCe2ekOCNX", "seller_details": { "external_id": null, "network_business_profile": "profile_test_61TU90nIeGjU7NNVXA6TU90m7ISQWsBxpcx9lASWWXTk" }, "setup_future_usage": null, "shared_metadata": {}, "status": "revoked", "usage_details": { "amount_captured": { "value": 0, "currency": "usd" } }, "usage_limits": { "currency": "usd", "expires_at": 1751587220, "max_amount": 1000 }}