LogoLogo
PayShield - Order Insight / TxFind
PayShield - Order Insight / TxFind
  • Overview
    • Overview
  • Integration
    • Integration Overview
    • Merchant Integration
    • Provider Integration
  • Provider
    • Verifi Provider Search
    • EMS Provider Search
  • Merchant
    • Store Transaction Details
    • Update Transaction Details
    • Validate Cart Details
    • Upload Transaction Batch
    • Upload Transaction Batch File
    • Get Merchant Descriptors
  • Cart
    • cart Flag alert received
    • cart Flag chargeback received
    • get all cart attachment data and related meta data
Powered by GitBook
On this page
Edit on GitHub
  1. Merchant

Get Merchant Descriptors

PreviousUpload Transaction Batch FileNextcart Flag alert received

Last updated 7 months ago

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
Path parameters
merchantIdstringRequired

Merchant Id to fetch descriptors for

Responses
200
Successful Response
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
get
GET /api/v2/merchant/{merchantId}/descriptors HTTP/1.1
Host: {baseurl}
Authorization: Bearer JWT
Accept: */*
[
  {
    "descriptorId": "07d98bc9-cb24-42c2-b841-ed33ed4ca48f",
    "title": "Bumper",
    "merchantId": "XXXXXXXXX",
    "merchantName": "Tesla",
    "active": true,
    "dateCreated": "2023-10-07T04:22:38.834Z"
  }
]
  • Headers
  • Path Parameters
  • GETGet Merchant Descriptors