{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading","endpoint","br","details","required"]},"type":"markdown"},"seo":{"title":"Revoke gateway token consent","description":"Transform your commerce with PXP's unified platform—seamless payments, real-time insights, and global growth in one powerful integration.","lang":"en-UK","siteUrl":"https://developer.pxp.io"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"revoke-gateway-token-consent","__idx":0},"children":["Revoke gateway token consent"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Revoke user consent for a specific gateway token to prevent future use."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-start","__idx":1},"children":["Before you start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Revoke works only when consent was saved with the gateway token. When you ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/token-vault"},"children":["create the token"]},", include optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerConsent"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasCustomerConsent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantId"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantShopperId"]},". If you skip that step (e.g., in a recurring payment flow), this endpoint returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," because there's nothing to revoke."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"revoke-consent-for-a-gateway-token","__idx":2},"children":["Revoke consent for a gateway token"]},{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"DELETE"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["/token-vault/{ownerType}/{ownerId}/vaults/gateway-tokens/{gatewayTokenId}/user-consents/{merchantId}/{merchantShopperId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-example","__idx":3},"children":["Request example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following request to revoke user consent for a gateway token."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -i -X DELETE \\\n  https://api-services.pxp.io/api/v1/token-vault/merchantgroup/fcc/vaults/gateway-tokens/ee18cb07-5855-46a0-85af-a3f86a9e3a1b/user-consents/MERCHANT-001/6152 \\\n  -H 'Content-Type: application/json'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters","__idx":4},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerType"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (enum)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of entity that owns the token vault. Use with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerId"]}," to identify which vault to use.",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},"Possible values:",{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Referrer"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MerchantGroup"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Merchant"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Site"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (0 to 20 characters)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The identifier of the vault owner. This must match the owner type. For example, provide your merchant group ID when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MerchantGroup"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gatewayTokenId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string (UUID)"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The gateway token ID. It must belong to the vault for this ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerId"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The merchant identifier associated with the consent. Use the same value you stored in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerConsent"]}," when you created the token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantShopperId"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Details","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"Break","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Required","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your unique identifier for the shopper. Use the same value you stored in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerConsent"]}," when you created the token. Matching is case-sensitive and doesn't ignore spaces."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-example","__idx":5},"children":["Response example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your request is successful, you'll receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," response with no content. This confirms that consent has been revoked and that the token can't be used for future transactions until consent is granted again."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},", no matching consent was found. Check the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Consent was stored when the token was created (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerConsent"]}," on create)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantShopperId"]}," match the stored values exactly, including case and spaces for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["merchantShopperId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gatewayTokenId"]}," belongs to the vault for the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerId"]}," in the URL."]}]}]},"headings":[{"value":"Revoke gateway token consent","id":"revoke-gateway-token-consent","depth":1},{"value":"Before you start","id":"before-you-start","depth":2},{"value":"Revoke consent for a gateway token","id":"revoke-consent-for-a-gateway-token","depth":2},{"value":"Request example","id":"request-example","depth":3},{"value":"Path parameters","id":"path-parameters","depth":4},{"value":"Response example","id":"response-example","depth":3}],"frontmatter":{"seo":{"title":"Revoke gateway token consent"}},"lastModified":"2026-10-29T12:08:59.476Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/token-vault/revoke-gateway-token-consent","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}