List Merchants

Overview

Retrieve a list of Merchant resources with extensive filtering options. Use this endpoint to search and filter Merchants based on various criteria including status, identity, and merchant name.

Resource Access

• User Permissions: All users can access this endpoint
• Endpoint: GET /merchants

Arguments

Parameter	Type	Required	Description
limit	integer	No	The maximum number of results to return (default: 10)
identity_id	string	No	Filter by the Merchant's Identity ID
processing_enabled	boolean	No	Filter by processing status (true/false)
merchant_name.like	string	No	Filter by partial Merchant Name (case-insensitive match)
after_cursor	string	No	Return every resource created after the cursor value for pagination

Example Request

curl -X GET \
  'https://api.ahrvo.network/payments/na/merchants?limit=20&processing_enabled=true' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response

{
  "_embedded": {
    "merchants": [
      {
        "id": "MUmerchantExample123",
        "created_at": "2023-06-15T10:30:00Z",
        "updated_at": "2023-06-15T10:30:00Z",
        "application": "APapplicationExample123",
        "identity": "IDentityExample123",
        "processor": "DUMMY_V1",
        "gateway": "DATACAP_V1",
        "mid": "987654321",
        "merchant_name": "Acme Retail Store",
        "mcc": "5411",
        "country": "USA",
        "currencies": ["USD"],
        "onboarding_state": "APPROVED",
        "processing_enabled": true,
        "settlement_enabled": true,
        "is_terminated": false,
        "loan_repayment": false,
        "level_two_level_three_data_enabled": false,
        "convenience_charges_enabled": false,
        "settlement_queue_mode": "UNSET",
        "tags": {
          "business_type": "retail"
        },
        "termination_details": null,
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123"
          }
        }
      }
    ]
  },
  "page": {
    "offset": 0,
    "limit": 20,
    "count": 1
  }
}

Additional Information

• Filtering Options: The endpoint supports extensive filtering including:
  • identity_id: Find all Merchants for a specific Identity
  • processing_enabled: Filter by whether payment processing is enabled
  • merchant_name.like: Search for Merchants by partial name match
  • Additional filters available for application, processor, onboarding state, and more
• Pagination: Use the after_cursor parameter to paginate through large result sets
• Onboarding States:
  • PROVISIONING: Merchant is being set up
  • APPROVED: Merchant can process payments
  • FAILED: Underwriting failed
• Processing Status: processing_enabled indicates whether the Merchant can currently accept payments
• Settlement Status: settlement_enabled indicates whether the Merchant can receive payouts
• Merchant ID (MID): The processor-assigned Merchant ID (null until approved)