---
agentTools:
  projectIndex: https://docs.o21.io/llms.txt
---

# Get a merchant

Return a details informations of merchant shop

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "O21Pay API Reference",
    "summary": "O21Pay API Reference",
    "description": "O21Pay API Reference",
    "version": "1.0.0"
  },
  "paths": {
    "/merchants/{id_merchant}": {
      "get": {
        "tags": [
          "Merchant"
        ],
        "summary": "Get a merchant",
        "description": "Return a details informations of merchant shop",
        "parameters": [
          {
            "name": "clientid",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "secret",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id_merchant",
            "in": "path",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "secretkey",
            "in": "query",
            "description": "Get only secretkey",
            "required": false,
            "schema": {
              "type": "string",
              "default": "get"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Merchant"
                }
              }
            }
          },
          "400": {
            "description": "Check the parameters or the syntax"
          },
          "401": {
            "description": "Unauthorized Couldn’t authenticate the request"
          },
          "404": {
            "description": "Merchant Not Found"
          }
        }
      }
    }
  },
  "security": [],
  "servers": [
    {
      "url": "https://o21c.obvious21.com/api/v1",
      "description": ""
    },
    {
      "url": "https://sandbox-o21c.obvious21.com/api/v1",
      "description": ""
    }
  ],
  "components": {
    "schemas": {
      "Merchant": {
        "title": "Merchant",
        "type": "object",
        "properties": {
          "id_merchant": {
            "type": "string",
            "description": "Merchant ID",
            "example": "39c30d69-e5c9-4608-93e0-c269c07fb1fe"
          },
          "name": {
            "type": "string",
            "description": "Merchant Name",
            "example": "My Shop"
          },
          "description": {
            "type": "string",
            "description": "Description Merchant Shop",
            "example": "My sales site"
          },
          "image": {
            "type": "string",
            "description": "URL of image for merchant shop",
            "example": "https://assets.obvious21.com/xxxx.png"
          },
          "url": {
            "type": "string",
            "description": "URL of merchant shop",
            "example": "https://mysite.com"
          },
          "mail": {
            "type": "string",
            "description": "Address email for receipt",
            "example": "receipt@domain.com"
          },
          "webhook": {
            "type": "string",
            "description": "URL of webhook",
            "example": "https://mysite.com/webhook/o21pay"
          },
          "whitelist": {
            "type": "string",
            "description": "List of IP authorized (0.0.0.0 for All)",
            "example": "1.1.1.1,1.1.1.2"
          },
          "enabled": {
            "type": "boolean",
            "description": "Enable/Disable merchant shop",
            "example": true
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Merchant",
      "description": "Merchants Shop"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 26,
      "2": 207,
      "3": 68,
      "4": 10,
      "5": 95,
      "6": 186,
      "7": 0,
      "8": 31,
      "9": 209,
      "10": 87,
      "11": 132
    }
  }
}
```