Get merchant's business and owner information

API Method: GET /api/v1/merchant/parameters

Description:

This API endpoint retrieves detailed information about a merchant's business and owner(s). It provides relevant data necessary for verifying the merchant's identity and business legitimacy in the payment processing service. This data typically includes both business-related information and owner-specific details.

Purpose:

To allow clients (payment processors, platforms, or administrators) to fetch comprehensive information about a merchant, such as business registration details, owner(s) data, and other key parameters required for onboarding, compliance, and risk management.

URL:

GET /api/v1/merchant/parameters

Headers:

• Authorization: Basic API key for authentication (required).

Response:

The API returns a JSON object containing detailed merchant business information along with the owner(s)' personal and business-related details. Below is an outline of potential fields in the response:

Response Body:

JSON HERE

Key Response Fields:

• merchant__profile_id: Unique identifier of the merchant.
• business_name: The legal name of the merchant's business.
• business_address: Full address of the business.
• business_phone: Contact phone number for the business.
• business_email: Email address associated with the business.
• tax_id: The business’s tax identification number (EIN or equivalent).
• business_type: The industry or nature of the business (e.g., retail, restaurant).
• ownership_details: An array of owner details, including:
  • owner_id: Unique identifier for the owner.
  • owner_name: Full name of the business owner.
  • owner_address: Address of the owner.
  • owner_email: Owner's email address.
  • owner_phone: Contact phone number for the owner.
  • ownership_percentage: Percentage of ownership in the business.
  • date_of_birth: Date of birth of the owner.
• date_registered: Date when the merchant was registered with the payment processor.

Response Codes:

• 200 OK: The request was successful, and the merchant’s business and owner information is returned.
• 401 Unauthorized: Authentication failed or the API key/token is invalid.
• 403 Forbidden: The user does not have permission to access this merchant's data.
• 404 Not Found: The requested merchant information was not found.
• 500 Internal Server Error: An error occurred on the server while processing the request.

Notes:

• Ensure that the appropriate authentication is used to access this endpoint.
• Sensitive information, such as the owner's date of birth or tax ID, should be handled securely to maintain privacy and compliance with data protection regulations.