Descriptor Enrollment List

This endpoint will return the descriptor that are requested for enrollment and their status

post

Authorizations

Body

statusstring[]Optional

Descriptor enrollment status. Values can be any of the following PENDING, FAILED, ENROLLED, UNENROLLED, WAITING FOR ACTION and WAITING FOR PROVIDER

sidstring[]Optional

Site IDs. This field is optional.

ridstring[]Optional

Retailers IDs. This field is optional.

midstring[]Optional

Merchants IDs. This field is optional

date_tostringOptional

this filter will be applied to request_date. This field is optional

date_fromstringOptional

this filter will be applied to request_date. This field is optional

sizestringOptional

Prefered number of result per request. This field is required

offsetstringOptional

Prefered number of offset per request. This field is required

orderstringOptional

default value is DESC. This field is optional

sort_fieldstringOptional

Determine what field will to apply the order by. This field is optional

Responses

200

Successfully returned enrollment request id

application/json

401

Unauthorized

application/json

500

Error

application/json

post

HTTPcURLJavaScriptPython

POST /txalerts/descriptor_enrollments HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "status": [
    "text"
  ],
  "sid": [
    "text"
  ],
  "rid": [
    "text"
  ],
  "mid": [
    "text"
  ],
  "date_to": "text",
  "date_from": "text",
  "size": "text",
  "offset": "text",
  "order": "text",
  "sort_field": "text"
}

{
  "list": [
    {
      "enrollment_request_id": 1,
      "merchant_name": "text",
      "site_name": "text",
      "products": "text",
      "status": "text",
      "request_date": "text",
      "last_activity": "text",
      "completed_at": "text",
      "enrollment_items": [
        {
          "descriptor": "text",
          "provider": "text",
          "status": "text",
          "last_activity": "text",
          "match_type": "text",
          "mcc": "text",
          "visa_bin": "text",
          "visa_caid": "text",
          "visa_arn": "text",
          "rdr_ruleset": "text"
        }
      ]
    }
  ],
  "totalResult": 1
}