---
title: "Merchant Report"
method: GET
path: "/reports/merchants"
tags: ["Reports"]
---

# Merchant Report

`GET /reports/merchants`

This report provides information about a merchant and their sub-merchants.

## Response `200`

A merchant object.

- MerchantReport
  - `data` MerchantRecord[]
    - `merchant_id` number — The id of the merchant.
    - `merchant_name` string — The name of the merchant.
    - `website` string — The merchant's website.
    - `address` MerchantAddress
      - `street_address` string — Street address
      - `province` string — characters (2)
      - `country` string — Country name
      - `postal_code` string — Postal/Zip code
    - `merchant_status` MerchantStatus
      - `status` 'Active' | 'Temporarily Disabled' | 'Disabled' | 'Closed' — The status of this merchant.
      - `state` 'Created' | 'Approved' | 'Declined' | 'Pending' | 'Live' | 'Disabled' | 'Enabled' | 'Authorized' | 'Received' — The state of this merchant.
      - `live_date` string, date — The date this merchant went live.
      - `created_date` string, date — The date this merchant was created.
      - `authorized_date` string, date — The date this merchant was authorized.
      - `temp_disabled_date` string, date — The date this merchant was temp disabled.
      - `last_enabled_date` string, date — The date that an account was enabled after being 'temp disabled'
      - `disabled_date` string, date — The date this merchant was disabled.
    - `processor` MerchantProcessor
      - `processor_name` string — The name of this processor.
      - `currency` string — The currency abbreviation for this processor.
    - `batch` Batch
      - `batch_limit` number, double — Processing limit for batches.
      - `batch_line_limit` number, double — Processing limit per line for batches.
      - `eft_credit_lag` number — Settlement lag for eft.
    - `settlement` Settlement
      - `credit_lag` number — Settlement lag for credit.
    - `cards` MerchantCards
      - `mastercard_enabled` boolean — Whether the merchant is configured to process MasterCard.
      - `visa_enabled` boolean — Whether the merchant is configured to process Visa.
      - `amex_enabled` boolean — Whether the merchant is configured to process Amex.
      - `discover_enabled` boolean — Whether the merchant is configured to process Discover.
      - `diners_enabled` boolean — Whether the merchant is configured to process Diners.
      - `jcb_enabled` boolean — Whether the merchant is configured to process JCB.
      - `mastercard_debit_enabled` boolean — Whether the merchant is configured to process MasterCard Debit.
      - `visa_debit_enabled` boolean — Whether the merchant is configured to process Visa Debit.
    - `features` MerchantFeatures
      - `checkout_enabled` boolean — Whether the merchant is configured to use Checkout.
      - `payment_profile_enabled` boolean — Whether the merchant is configured to use Payment Profiles.
      - `recurring_billing_enabled` boolean — Whether the merchant is configured to use Recurring Billing.
      - `credit_card_batch_enabled` boolean — Whether the merchant is configured to use Credit Card Batch.
      - `eft_ach_enabled` boolean — Whether the merchant is configured to use Eft/Ach.
      - `visa_src_enabled` boolean — Whether the merchant is configured to use Visa Src.

## Other responses

- `400` — Bad Request
- `401` — Authentication Failure
- `402` — Business Rule Violation or Decline
- `403` — Authorization Failure
- `405` — Invalid Request Method
- `500` — Internal Server Error

---

[API](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis.md) · [All operations](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/worldline-solutions/worldline-payment-apis/revisions/d661d9e357a1/schema)