Control a processor's access to products
POST /processor/token/permissions/set
Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change.
Request Body
Required
ProcessorTokenPermissionsSetRequest defines the request schema for /processor/token/permissions/set
Parameters
client_id
Your Plaid API
client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
Your Plaid API
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
processor_token
The processor token obtained from the Plaid integration partner. Processor tokens are in the format:
processor-<environment>-<identifier>
products
A list of products the processor token should have access to. An empty list will grant access to all products.
Response
ProcessorTokenPermissionsSetResponse defines the response schema for /processor/token/permissions/set
Response Properties
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.