> For the complete documentation index, see [llms.txt](https://docs.payshield.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payshield.ai/txalerts-dispute-alerts/api-endpoints/descriptor-enrollment-list.md). # Descriptor Enrollment List This endpoint will return the descriptor that are requested for enrollment and their status ## POST /txalerts/descriptor\_enrollments > ```json {"openapi":"3.0.1","info":{"title":"TxShield api V3.0","version":"3.0"},"tags":[{"name":"Alerts","description":"Call related to alerts in txshield core."}],"servers":[{"url":":///api/v3"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AlertDescriptorEnrollmentsList":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/AlertDescriptorEnrollmentsListItem"}},"totalResult":{"type":"integer"}}},"AlertDescriptorEnrollmentsListItem":{"type":"object","properties":{"enrollment_request_id":{"type":"integer"},"merchant_name":{"type":"string"},"site_name":{"type":"string"},"products":{"type":"string"},"status":{"type":"string"},"request_date":{"type":"string"},"last_activity":{"type":"string"},"completed_at":{"type":"string"},"enrollment_items":{"type":"array","items":{"type":"object","properties":{"descriptor":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"last_activity":{"type":"string"},"match_type":{"type":"string","description":"match_type only exist if provider has Ethoca or CDRN"},"mcc":{"type":"string","description":"mcc only exist if provider has RDR"},"visa_bin":{"type":"string","description":"visa_bin only exist if provider has RDR"},"visa_caid":{"type":"string","description":"visa_caid only exist if provider has RDR"},"visa_arn":{"type":"string","description":"visa_arn only exist if provider has RDR"},"rdr_ruleset":{"type":"string","description":"rdr_ruleset only exist if provider has RDR"}}}}}},"Error":{"type":"object","properties":{"msg":{"type":"string"},"details":{"type":"string"}}}}},"paths":{"/txalerts/descriptor_enrollments":{"post":{"tags":["Alerts"],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"status":{"type":"array","description":"Descriptor enrollment status. Values can be any of the following PENDING, FAILED, ENROLLED, UNENROLLED, WAITING FOR ACTION and WAITING FOR PROVIDER","items":{"type":"string"}},"sid":{"type":"array","description":"Site IDs. This field is optional.","items":{"type":"string"}},"rid":{"type":"array","description":"Retailers IDs. This field is optional.","items":{"type":"string"}},"mid":{"type":"array","description":"Merchants IDs. This field is optional","items":{"type":"string"}},"date_to":{"type":"string","description":"this filter will be applied to request_date. This field is optional"},"date_from":{"type":"string","description":"this filter will be applied to request_date. This field is optional"},"size":{"type":"integer","description":"Number of results to return. Passed directly into the underlying SQL LIMIT clause with no bounds enforced by the API. Effectively required — omitting it produces a malformed query and a 500 error."},"offset":{"type":"integer","description":"Number of rows to skip (row-based offset). Passed directly into the underlying SQL LIMIT clause with no bounds enforced by the API. Effectively required — omitting it produces a malformed query and a 500 error."},"order":{"type":"string","description":"default value is DESC. This field is optional"},"sort_field":{"type":"string","description":"Determine what field will to apply the order by. This field is optional"}}}},"application/json":{"schema":{"type":"object","properties":{"status":{"type":"array","description":"Descriptor enrollment status. Values can be any of the following PENDING, FAILED, ENROLLED, UNENROLLED, WAITING FOR ACTION and WAITING FOR PROVIDER","items":{"type":"string"}},"sid":{"type":"array","description":"Site IDs. This field is optional.","items":{"type":"string"}},"rid":{"type":"array","description":"Retailers IDs. This field is optional.","items":{"type":"string"}},"mid":{"type":"array","description":"Merchants IDs. This field is optional","items":{"type":"string"}},"date_to":{"type":"string","description":"this filter will be applied to request_date. This field is optional"},"date_from":{"type":"string","description":"this filter will be applied to request_date. This field is optional"},"size":{"type":"integer","description":"Number of results to return. Passed directly into the underlying SQL LIMIT clause with no bounds enforced by the API. Effectively required — omitting it produces a malformed query and a 500 error."},"offset":{"type":"integer","description":"Number of rows to skip (row-based offset). Passed directly into the underlying SQL LIMIT clause with no bounds enforced by the API. Effectively required — omitting it produces a malformed query and a 500 error."},"order":{"type":"string","description":"default value is DESC. This field is optional"},"sort_field":{"type":"string","description":"Determine what field will to apply the order by. This field is optional"}}}}}},"responses":{"200":{"description":"Successfully returned enrollment request id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertDescriptorEnrollmentsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.payshield.ai/txalerts-dispute-alerts/api-endpoints/descriptor-enrollment-list.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.