/api/v2/merchant/info

API Method: GET /api/v2/merchant/info

Description:

The GET /api/v1/merchant/info endpoint retrieves detailed information about a specific merchant within a payment processing system. This API call returns merchant-related details such as the merchant's identification, contact information, business data, account status, and other attributes that may be relevant to their interaction with the payment processing service.

Request:

  • Method: GET
  • Endpoint: /api/v2/merchant/info
  • Authentication: This endpoint requires authentication, typically using an API key, Basic type credentials.

Parameters:

  • Headers:

    • Authorization (required): Basic type credentials.
  • Query Parameters (required):

    • merchant_profile_id (required): The unique identifier of the merchant whose information is to be retrieved. If not provided, the API returns information for the authenticated merchant associated with the API key or token.

Response:

The response is in JSON format, containing the following fields:

  • merchant_id (string): The unique identifier for the merchant.
  • name (string): The legal or business name of the merchant.
  • status (string): Current status of the merchant account (e.g., active, suspended, pending).
  • email (string): The contact email address associated with the merchant.
  • phone_number (string): The contact phone number for the merchant.
  • business_address (object): The business address details including:
    • street (string): Street address.
    • city (string): City name.
    • state (string): State or region.
    • zip_code (string): Postal code.
    • country (string): Country name.
    • status (string): Status of the payment method (e.g., active, inactive).

Error Responses:

  • 401 Unauthorized: The request was not authenticated, or the authentication token is invalid.
  • 404 Not Found: The specified merchant does not exist.
  • 500 Internal Server Error: A server error occurred while processing the request.

Notes:

  • This endpoint can be used by partners or payment integrators to fetch the merchant's data for reporting, account management, or onboarding purposes.
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!