Skip to main content

Fetch a Merchant

Overview​

Retrieve the details of a previously created Merchant. The Merchant resource represents a seller's payment processing account on a processor.

Resource Access​

  • User Permissions: All users can access this endpoint
  • Endpoint: GET /merchants/\{merchant_id}

Arguments​

ParameterTypeRequiredDescription
merchant_idstringYesThe unique ID of the Merchant to retrieve

Example Request​

curl -X GET \
  'https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response​

{
  "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": true,
  "convenience_charges_enabled": false,
  "settlement_queue_mode": "UNSET",
  "tags": {
    "business_type": "retail",
    "location": "downtown"
  },
  "termination_details": null,
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123"
    },
    "identity": {
      "href": "https://api.ahrvo.network/payments/na/identities/IDentityExample123"
    },
    "verifications": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123/verifications"
    },
    "merchant_profile": {
      "href": "https://api.ahrvo.network/payments/na/merchant_profiles/MPprofileExample123"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample123"
    }
  }
}

Additional Information​

  • Merchant Status Fields:
    • onboarding_state: Current underwriting status (PROVISIONING, APPROVED, or FAILED)
    • processing_enabled: Whether the Merchant can accept payments
    • settlement_enabled: Whether the Merchant can receive settlements
    • is_terminated: Indicates if the account has been terminated
  • Processor Information:
    • processor: The payment processor (e.g., DUMMY_V1, LITLE_V1)
    • gateway: The gateway for card-present processing (if applicable)
    • mid: Merchant ID assigned by the processor (available after approval)
  • Feature Flags:
    • level_two_level_three_data_enabled: Enhanced data for B2B/B2G transactions
    • convenience_charges_enabled: Ability to add buyer convenience fees
    • loan_repayment: Loan repayment functionality
  • Settlement Configuration:
    • settlement_queue_mode: Controls automated settlement queueing (UNSET or MANUAL)
  • Merchant Category Code (MCC): Industry classification code (e.g., 5411 for grocery stores)
  • Currencies: Supported currencies for this Merchant account