Get agent details

API Endpoint: GET /api/v1/agent/profile

Description:

This API endpoint retrieves detailed information about an agent within the payment processing service. The agent's profile includes essential data such as personal and business information, contact details, and other relevant information that allows the agent to participate in the merchant boarding process.

Purpose:

This endpoint is used by the payment processing service to fetch the profile information of a specific agent involved in merchant onboarding. It allows for verification, display, or further processing of agent details within the system.

Request Method:

• GET

Endpoint:

• /api/v1/agent/profile

Authentication:

• Required: Yes
• Authentication Method: Typically via Basic Token or API Key in the request headers.

Request Headers:

• Authorization: Basic<token> (required) - Authentication token to verify and authorize the API call.
• Content-Type: application/json (optional if needed for additional payload).

Query Parameters:

• None (agent profile is typically associated with the token used for authentication, so no additional parameters are required).

Success Response:

• Status Code: 200 OK
• Response Body (JSON format):
  JSON

  {
  "data": {
    "id": 0,
    "name": "string",
    "payoutNumber": "string",
    "agentId": 0,
    "agentName": "string",
    "agentOfficeId": 0,
    "agentOfficeName": "string",
    "agentUserName": "string",
    "email": "string",
    "phone": "string"
  },
  "status": "Continue",
  "error": "string",
  "warning": "string",
  "validationResults": [
    {
      "memberNames": [
        "string"
      ],
      "errorMessage": "string"
    }
  ],
  "requestId": 0
  }
  

Error Responses:

• 401 Unauthorized:
  • Occurs if the request lacks valid authentication credentials.
  • Response body:
    JSON

    {
      "error": "Unauthorized",
      "message": "Invalid or missing token"
    }
    

• 404 Not Found:
  • Occurs if the agent profile does not exist or is inaccessible.
  • Response body:
    JSON

    {
      "error": "Not Found",
      "message": "Agent profile not found"
    }
    

• 500 Internal Server Error:
  • Occurs if there is a server-side issue.
  • Response body:
    JSON

    {
      "error": "Internal Server Error",
      "message": "An error occurred while fetching the agent profile"
    }
    

Notes:

• Ensure that the API token used is valid and associated with the correct agent to retrieve the appropriate profile information.