Partner Management APIs

API documentation for managing partners, including partner creation, profile updates, partner retrieval, deletion, bulk deletion, and search operations. Access is available to authorized Super Admin and Partner users, subject to endpoint-level permissions.

Overview

The Partner Management APIs provide endpoints for managing partner records and maintaining partner information within the EdfaPay platform.

This section covers the core partner management operations, including creating new partners, updating existing partner details, retrieving partner information, searching and filtering partner records, and deleting individual or multiple partners.

Each endpoint documents its HTTP method, endpoint path, required parameters, request body, access permissions, and response structure.

Available Operations

1. Create Partner

Create a new partner record by submitting the required partner information and configuration.

Method: POST

Endpoint: /api/v1/partner

Access Levels: SUPER_ADMIN, PARTNER

2. Update Partner

Update an existing partner's information and configuration.

Method: PUT

Endpoint: /api/v1/partner

Access Levels: SUPER_ADMIN, PARTNER

3. Get Partner Details

Retrieve the details of a specific partner using its unique partner ID.

Method: GET

Endpoint: /api/v1/partner/{partnerId}

Access Levels: SUPER_ADMIN, PARTNER

4. Search Partners

Search and retrieve partner records using search criteria and pagination settings.

Method: GET

Endpoint: /api/v1/partner/search

Access Levels: SUPER_ADMIN, PARTNER

5. Delete Partner

Delete an existing partner using its unique partner ID.

Method: DELETE

Endpoint: /api/v1/partner/{partnerId}

Access Levels: SUPER_ADMIN, PARTNER

6. Delete Multiple Partners

Delete multiple partner records by submitting a list of partner IDs.

Method: PATCH

Endpoint: /api/v1/partner/batch-delete

Access Levels: SUPER_ADMIN, PARTNER

Authentication

Requests must include the API key configured for the relevant environment.

HeaderValue
X-API-KEYYOUR_API_KEY
Accept*/*

Production Base URL: https://app-api.edfapay.com

Use valid credentials and ensure the authenticated user has the permissions required for the selected endpoint.

Standard Response Structure

The documented endpoints use a response envelope containing the following fields:

  • code — Response code.
  • message — Response message.
  • errorCode — Error identifier, when provided.
  • data — Response payload, which depends on the operation.

Successful requests return HTTP 200 OK according to the documented endpoint responses. Invalid requests may return HTTP 400 Bad Request.

Refer to each individual endpoint for its exact request schema and response details.

Integration Guidelines

  • Use a valid partner ID when performing operations on an existing partner.
  • Provide all required fields in the request body when creating or updating a partner.
  • Follow the documented schemas for partner details, logo information, and configuration fields.
  • For search operations, provide the required pagination and search criteria.
  • For bulk deletion, submit the partner IDs in the format specified by the endpoint.
  • Handle unsuccessful responses and validate the returned status and response fields.

Related Endpoints

Select the relevant endpoint in the navigation panel to view its complete API reference, request examples, required fields, access levels, and response schemas.


Did this page help you?