--- updatedAt: 2025-12-30T15:00:44.000Z agentTools: projectIndex: https://docs.staxpayments.com/llms.txt --- # Get Merchant by ID Retrieves the merchant specified by the {id} parameter. This route returns the merchant specified in the request URL. The response ID matches the merchant ID used in our other enrollment-related routes. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "stax-api", "version": "0.1" }, "servers": [ { "url": "https://apiprod.fattlabs.com/" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality." }, "PartnerApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Partner-level API key with elevated privileges. Grants access to all partner operations including merchant management, portfolio oversight, reporting across multiple merchant accounts, and partner-specific administrative functions. Also provides access to all merchant-level operations for accounts under the partner's management." } } }, "security": [ { "ApiKeyAuth": [] } ], "paths": { "/merchant/{merchant_id}": { "get": { "summary": "Get Merchant by ID", "description": "Retrieves the merchant specified by the {id} parameter.", "operationId": "get-merchant-by-id", "parameters": [ { "name": "merchant_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "ID of the merchant." } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"65649c08-71be-4745-a437-c265df8f3ed3\",\n \"mid\": \"\",\n \"status\": \"PENDING\",\n \"subdomain\": \"\",\n \"company_name\": \"Test merchant\",\n \"display_name\": \"Test merchant\",\n \"contact_name\": \"\",\n \"contact_email\": \"payments@test.io\",\n \"contact_phone\": \"\",\n \"address_1\": \"\",\n \"address_2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_zip\": \"\",\n \"hosted_payments_token\": \"Test Merchant\",\n \"currency\": [\n \"USD\"\n ],\n \"plan\": {\n \"id\": \"ecc2e251-278d-4322-aaae-e4ba985f8f40\",\n \"merchant_id\": \"65649c08-71be-4745-a437-c265df8f3765\",\n \"user_id\": \"c3a7f735-a8f0-4ca1-937d-d0f2b76ba44b\",\n \"name\": \"plan-0\",\n \"created_at\": \"2021-07-14 18:53:53\",\n \"updated_at\": \"2021-07-14 18:53:53\"\n },\n \"options\": null,\n \"notes\": \"\",\n \"gateway_type\": null,\n \"vendor_keys\": null,\n \"processor\": \"\",\n \"partner\": null,\n \"product_type\": \"Other\",\n \"is_enterprise\": false,\n \"is_payfac\": false,\n \"is_sandbox\": false,\n \"fm_billing_schedule_id\": null,\n \"fee_reconciliation_payment_method_id\": null,\n \"welcome_email_sent_at\": null,\n \"created_at\": \"2021-07-14 18:53:52\",\n \"updated_at\": \"2021-07-14 18:53:52\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"risk_hold\": false,\n \"branding\": null,\n \"allow_ach\": false,\n \"is_portal\": false,\n \"is_flat_rate\": false,\n \"allow_credits\": false,\n \"allow_terminal\": false,\n \"gateways\": [],\n \"is_surcharge_enabled\": false,\n \"is_trust\": false,\n \"users\": [\n {\n \"id\": \"c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b\",\n \"system_admin\": false,\n \"name\": \"Test user\",\n \"email\": \"payments@test.io\",\n \"email_verification_sent_at\": null,\n \"email_verified_at\": null,\n \"is_api_key\": false,\n \"options\": null,\n \"acknowledgments\": {\n \"setPassword\": true\n },\n \"created_at\": \"2021-07-14 18:51:27\",\n \"updated_at\": \"2021-07-14 18:53:16\",\n \"deleted_at\": null,\n \"brand\": \"fattmerchant\",\n \"gravatar\": \"//www.gravatar.com/avatar/c75f409ceae6d2a2ca1efdc2a313236f\",\n \"team_admin\": true,\n \"team_enabled\": true,\n \"team_role\": \"admin\",\n \"merchant_options\": [],\n \"is_default\": false,\n \"brands\": [\n \"fattmerchant\"\n ],\n \"pivot\": {\n \"merchant_id\": \"65649c08-71be-4745-a437-c265df8f3ed3\",\n \"user_id\": \"c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b\",\n \"is_default\": false,\n \"team_role\": \"admin\",\n \"deleted_at\": null,\n \"merchant_options\": [],\n \"created_at\": \"2021-07-14 18:53:53\",\n \"updated_at\": \"2021-07-14 18:53:53\"\n }\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "65649c08-71be-4745-a437-c265df8f3ed3" }, "mid": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PENDING" }, "subdomain": { "type": "string", "example": "" }, "company_name": { "type": "string", "example": "Test merchant" }, "display_name": { "type": "string", "example": "Test merchant" }, "contact_name": { "type": "string", "example": "" }, "contact_email": { "type": "string", "example": "payments@test.io" }, "contact_phone": { "type": "string", "example": "" }, "address_1": { "type": "string", "example": "" }, "address_2": { "type": "string", "example": "" }, "address_city": { "type": "string", "example": "" }, "address_state": { "type": "string", "example": "" }, "address_zip": { "type": "string", "example": "" }, "hosted_payments_token": { "type": "string", "example": "Test Merchant" }, "currency": { "type": "array", "items": { "type": "string", "example": "USD" } }, "plan": { "type": "object", "properties": { "id": { "type": "string", "example": "ecc2e251-278d-4322-aaae-e4ba985f8f40" }, "merchant_id": { "type": "string", "example": "65649c08-71be-4745-a437-c265df8f3765" }, "user_id": { "type": "string", "example": "c3a7f735-a8f0-4ca1-937d-d0f2b76ba44b" }, "name": { "type": "string", "example": "plan-0" }, "created_at": { "type": "string", "example": "2021-07-14 18:53:53" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:53" } } }, "options": {}, "notes": { "type": "string", "example": "" }, "gateway_type": {}, "vendor_keys": {}, "processor": { "type": "string", "example": "" }, "partner": {}, "product_type": { "type": "string", "example": "Other" }, "is_enterprise": { "type": "boolean", "example": false, "default": true }, "is_payfac": { "type": "boolean", "example": false, "default": true }, "is_sandbox": { "type": "boolean", "example": false, "default": true }, "fm_billing_schedule_id": {}, "fee_reconciliation_payment_method_id": {}, "welcome_email_sent_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "example": "2021-07-14 18:53:52" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:52" }, "deleted_at": { "type": "string" }, "brand": { "type": "string", "example": "fattmerchant" }, "risk_hold": { "type": "boolean", "example": false, "default": true }, "branding": { "type": "string" }, "allow_ach": { "type": "boolean", "example": false, "default": true }, "is_portal": { "type": "boolean", "example": false, "default": true }, "is_flat_rate": { "type": "boolean", "example": false, "default": true }, "allow_credits": { "type": "boolean", "example": false, "default": true }, "allow_terminal": { "type": "boolean", "example": false, "default": true }, "gateways": { "type": "array" }, "is_surcharge_enabled": { "type": "boolean", "example": false, "default": true }, "is_trust": { "type": "boolean", "example": false, "default": true }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b" }, "system_admin": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "Test user" }, "email": { "type": "string", "example": "payments@test.io" }, "email_verification_sent_at": { "type": "string", "format": "date-time" }, "email_verified_at": { "type": "string", "format": "date-time" }, "is_api_key": { "type": "boolean", "example": false, "default": true }, "options": {}, "acknowledgments": { "type": "object", "properties": { "setPassword": { "type": "boolean", "example": true, "default": true } } }, "created_at": { "type": "string", "example": "2021-07-14 18:51:27" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:16" }, "deleted_at": { "type": "string", "format": "date-time" }, "brand": { "type": "string", "example": "fattmerchant" }, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/c75f409ceae6d2a2ca1efdc2a313236f" }, "team_admin": { "type": "boolean", "example": true, "default": true }, "team_enabled": { "type": "boolean", "example": true, "default": true }, "team_role": { "type": "string", "example": "admin" }, "merchant_options": { "type": "array" }, "is_default": { "type": "boolean", "example": false, "default": true }, "brands": { "type": "array", "items": { "type": "string", "example": "fattmerchant" } }, "pivot": { "type": "object", "properties": { "merchant_id": { "type": "string", "example": "65649c08-71be-4745-a437-c265df8f3ed3" }, "user_id": { "type": "string", "example": "c3a7f735-a8fa-4ca1-937d-d0f2b76ba44b" }, "is_default": { "type": "boolean", "example": false, "default": true }, "team_role": { "type": "string", "example": "admin" }, "deleted_at": { "type": "string", "format": "date-time" }, "merchant_options": { "type": "array" }, "created_at": { "type": "string", "example": "2021-07-14 18:53:53" }, "updated_at": { "type": "string", "example": "2021-07-14 18:53:53" } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "security": [ { "PartnerApiKey": [] } ] } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```