Get Merchant Details API

Retrieves merchant details using the merchant's UUID. Supports SUPER_ADMIN, PARTNER, and MERCHANT access levels, subject to the authenticated user's permissions.

1. Overview

The Get Merchant Details API retrieves merchant information using a specific merchant ID.

It allows authorized users to request details for an individual merchant by providing the merchant's UUID in the URL path.

Access Levels: SUPER_ADMIN, PARTNER, MERCHANT

2. Endpoint Details

PropertyValue
API NameMerchant Details
HTTP MethodGET
Endpoint/api/v1/merchant/{merchantId}
Production Base URLhttps://app-api.edfapay.com
Accept*/*
Request BodyNot required

3. Authentication

Include the API key in the request headers.

HeaderValue
X-API-KEYYOUR_API_KEY
Accept*/*

4. Path Parameters

ParameterTypeRequiredDescription
merchantIdUUID stringYesUnique identifier of the merchant whose details are being retrieved.

5. Request Example

Replace {merchantId} with the actual UUID of the merchant.

GET /api/v1/merchant/3fa85f64-5717-4562-b3fc-2c963f66afa6

6. cURL Example

curl --request GET \
  --url 'https://app-api.edfapay.com/api/v1/merchant/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: */*'

7. Responses

7.1 HTTP 200 — OK

Description: The request was processed successfully.

Example response:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

The data object contains the response data for the requested merchant. The supplied Swagger example does not specify its individual fields.

7.2 HTTP 400 — Bad Request

Description: The request could not be processed because of invalid request data or another request-related issue.

Example response:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

The values shown are Swagger placeholders. Actual response values depend on the API implementation.

8. Implementation Notes

  • Provide a valid UUID in the merchantId path parameter.
  • Use the GET method to retrieve merchant details.
  • No request body is required.
  • Include the API key in the X-API-KEY header.
  • The documented access levels are SUPER_ADMIN, PARTNER, and MERCHANT.
  • The supplied schema documents HTTP 200 and 400 responses.
  • The exact merchant fields returned in data are not shown in the provided Swagger response example.

9. Summary

The Get Merchant Details API retrieves information for a specific merchant using its UUID and returns the result in the standard EdfaPay response envelope.


Did this page help you?