Get Partner Details API
Retrieves partner details using a unique partner ID. This endpoint is available to authorized Super Admin and Partner users.
Overview
The Get Partner Details API retrieves information about a specific partner using the partner's unique identifier.
HTTP Method: GET
Endpoint: /api/v1/partner/{partnerId}
Access Levels: SUPER_ADMIN, PARTNER
Authentication
Include your API key in the request header.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
partnerId | UUID (string) | Yes | The unique identifier of the partner to retrieve. |
cURL Example
curl -X GET "https://app-api.edfapay.com/api/v1/partner/{partnerId}" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: */*"Replace {partnerId} with the actual partner UUID.
Example Request
GET /api/v1/partner/3fa85f64-5717-4562-b3fc-2c963f66afa6Responses
200 — OK
The request was processed successfully.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}The API schema shows data as an empty object ({}). The specific partner fields returned by this endpoint are not defined in the displayed response example.
400 — Bad Request
The request could not be processed because of invalid input or another request-related error.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Implementation Notes
- Provide a valid UUID in the
partnerIdpath parameter. - Ensure the authenticated user has the required access level.
- Check the response body for the
code,message, anderrorCodefields when handling the result.
Updated 25 days ago