Get Merchant Descriptors

GEThttps://{base_url}/v2/merchant/{merchantId}/descriptors

This endpoint retrieves all unique payment descriptors associated with a specific merchant. It first validates the presence of a merchant ID and performs an authorization check if JWT is enabled. Upon successful validation, it queries the database to find and return all descriptors for the given merchant. If no descriptors are found, a 404 error is returned. Otherwise, the endpoint returns a list of descriptors sorted by creation date. If any errors occur during execution, an appropriate error message is returned.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Path Parameters

Name	Description
merchantId	Merchant Id to fetch descriptors

Get Merchant Descriptors

Retrieve all unique descriptors for a specific merchant

GEThttps://{baseUrl}/api/v2/merchant/{merchantId}/descriptors

Authorization

bearerAuth

Path parameters

merchantId*string

Merchant Id to fetch descriptors for

Response

200400401404500

Successful Response

Body

application/json

descriptorIdstring

Example: "07d98bc9-cb24-42c2-b841-ed33ed4ca48f"

titlestring

Example: "Bumper"

merchantIdstring

Example: "XXXXXXXXX"

merchantNamestring

Example: "Tesla"

activeboolean

Example: true

dateCreatedstring (date-time)

Example: "2023-10-07T04:22:38.834Z"

Request

JavaScriptCurlPython

const response = await fetch('https://{baseUrl}/api/v2/merchant/{merchantId}/descriptors', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404500

[
  {
    "descriptorId": "07d98bc9-cb24-42c2-b841-ed33ed4ca48f",
    "title": "Bumper",
    "merchantId": "XXXXXXXXX",
    "merchantName": "Tesla",
    "active": true,
    "dateCreated": "2023-10-07T04:22:38.834Z"
  }
]