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

get

Retrieve all unique descriptors for a specific merchant

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

merchantIdstringRequired

Merchant Id to fetch descriptors for

Responses

200

Successful Response

application/json

descriptorIdstringOptionalExample: 07d98bc9-cb24-42c2-b841-ed33ed4ca48f

titlestringOptionalExample: Bumper

merchantIdstringOptionalExample: XXXXXXXXX

merchantNamestringOptionalExample: Tesla

activebooleanOptionalExample: true

dateCreatedstring · date-timeOptionalExample: 2023-10-07T04:22:38.834Z

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/api/v2/merchant/{merchantId}/descriptors

HTTPcURLJavaScriptPython

GET /api/v2/merchant/{merchantId}/descriptors HTTP/1.1
Host: {baseUrl}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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