---
updatedAt: 2025-06-16T20:55:46.000Z
agentTools:
  projectIndex: https://docs.payarc.net/llms.txt
---

# Sub-Merchant Customer Summary

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "payarc-sandbox-wo-try-it",
    "version": "1.2.0"
  },
  "servers": [
    {
      "url": "https://testapi.payarc.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "YourAPIBearerKey"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/agent-hub/merchant-bridge/submerchant-customers": {
      "get": {
        "summary": "Sub-Merchant Customer Summary",
        "description": "",
        "operationId": "sub-merchant-customer-summary",
        "parameters": [
          {
            "name": "report_date_from",
            "in": "query",
            "description": "Required with report_date_to and has date format: YYYY-MM-DD.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "report_date_to",
            "in": "query",
            "description": "Required with report_date_from and has date format: YYYY-MM-DD.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "from_date",
            "in": "query",
            "description": "Required with date_column and has date format: YYYY-MM-DD.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "to_date",
            "in": "query",
            "description": "Required with date_column and has date format: YYYY-MM-DD.",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "date_column",
            "in": "query",
            "description": "Required with from_date and to_date and possible values: first_batch_date, last_process_date, created_at.",
            "schema": {
              "type": "string",
              "enum": [
                "first_batch_date",
                "last_process_date",
                "created_at"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"object\": \"Account\",\n            \"id\": \"2643634dsfgsdgfs\",\n            \"mid\": \"2222222222222222\",\n            \"legal_name\": \"Test Property Management\",\n            \"dba_name\": \"Test Homeowners Assoc\",\n            \"email\": \"foo@payarc.com\",\n            \"status\": \"open\",\n            \"first_batch_date\": null,\n            \"last_process_date\": null,\n            \"pci_compliance_grade\": null,\n            \"gateway_type\": null,\n            \"trans_type\": null,\n            \"sic_code\": \"1111\",\n            \"approved_volume\": 250000,\n            \"residual_summary_mp\": 0,\n            \"residual_summary_ytm\": 0,\n            \"sales_mtd_amount\": 0,\n            \"sales_ytd_amount\": 0,\n            \"sales_amount\": 0,\n            \"sales_count\": 0,\n            \"refunds_amount\": 0,\n            \"refunds_count\": 0,\n            \"chargebacks_amount\": 0,\n            \"chargebacks_count\": 0,\n            \"created_at\": \"2024-09-30T14:15:47.000000Z\",\n            \"updated_at\": \"2024-09-30T14:45:51.000000Z\",\n            \"readable_created_at\": \"1 month ago\",\n            \"readable_updated_at\": \"1 month ago\"\n        },\n          ],\n    \"meta\": {\n        \"include\": [],\n        \"custom\": []\n    }\n}"
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"error\": \"Unauthenticated.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Unauthenticated."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```