Merchant Management APIs

Comprehensive API reference for managing merchant accounts on the EdfaPay platform, covering merchant creation, updates, retrieval, deletion, and search operations.

Overview

The EdfaPay Merchant Management APIs provide a standardized interface for managing merchant accounts throughout their lifecycle. These APIs enable authorized users to create and maintain merchant profiles, retrieve merchant information, search and filter merchant records, and perform individual or bulk deletion operations.

This section serves as the central reference for all merchant management endpoints, including their request structures, parameters, access permissions, and response formats.

Available Operations

Merchant Creation

Create new merchant accounts by submitting the required merchant information and configuration details.

Merchant Updates

Update existing merchant profiles and their supported configuration settings.

Merchant Details

Retrieve information associated with a specific merchant using its unique identifier.

Merchant Search

Search and filter merchant records using the supported search criteria and pagination parameters.

Merchant Deletion

Delete an individual merchant or process the deletion of multiple merchants through a single request.

API Reference

Select the relevant endpoint from the navigation menu to access its detailed documentation, including the HTTP method, endpoint path, required parameters, request body schema, and example responses.

Access and Authentication

Access to merchant management endpoints is governed by the permissions assigned to the authenticated user. Supported access levels are specified in the documentation for each endpoint.

Refer to the Authentication documentation for the applicable authentication requirements before making API requests.

Response Handling

API responses follow the response structure defined for each endpoint. Review the documented HTTP status codes and response payloads to handle successful requests and errors appropriately.

Important Notes

  • Provide valid identifiers and all required request fields.
  • Ensure the authenticated user has the necessary permissions for the requested operation.
  • Use the endpoint-specific schemas as the source of truth for request and response structures.
  • Validate request parameters and handle error responses before integrating these APIs into production workflows.

Did this page help you?