Get merchant by ID

curl https://api-sandbox.koywe.com/api/v1/organizations/org_abc123/merchants/mer_def456 \
     -H "Authorization: Bearer <token>"

{
  "merchantId": "mrc_31fd8637-f889-43fa-8b31-50d9296abfdc",
  "slug": "republic",
  "profile": {
    "name": "Galactic Republic Trading",
    "description": "1234 Main St, Coruscant",
    "address": "1234 Main St, Coruscant",
    "email": "galactic.republic@row.com",
    "phone": "1234567890",
    "url": "https://galacticrepublic.com",
    "supportEmail": "galacticrepublic",
    "supportPhone": "1234567890",
    "supportUrl": "https://galacticrepublic.com/support",
    "taxIdType": "RUT",
    "taxIdNumber": "123456789",
    "addressLine2": "Suite 100",
    "city": "Springfield",
    "postalCode": "90210",
    "stateId": "st_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "State": {
      "id": "id",
      "name": "name",
      "code": "code",
      "countryId": "countryId"
    },
    "countyId": "cnt_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "County": {
      "id": "id",
      "name": "name",
      "code": "code",
      "stateId": "stateId"
    },
    "Country": {
      "id": "id",
      "name": "name",
      "twoLetterIso": {
        "key": "value"
      },
      "fullName": "fullName"
    },
    "dateOfBirth": "1990-01-15T00:00:00Z",
    "nationalityCountryId": "ctry_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "nationalityCountry": {
      "key": "value"
    },
    "state": "California"
  },
  "businessType": "Galactic Republic Trading",
  "businessStructure": "Galactic Republic Trading",
  "capabilities": {
    "payments": true,
    "collections": true
  },
  "chargesEnabled": true,
  "countryId": "ctry_84b8b218-2777-4e7f-863e-7d0601ac289f",
  "createdAt": "2024-07-01T22:40:22Z",
  "defaultCurrencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64",
  "kybComplete": true,
  "disabled": true,
  "disabledReason": "N/D",
  "billing": {
    "roundingType": "NET"
  },
  "Country": {
    "id": "id",
    "name": "name",
    "twoLetterIso": {
      "key": "value"
    },
    "fullName": "fullName"
  },
  "branding": {
    "icon": "https://example.com/icon.png",
    "logo": "https://example.com/logo.png",
    "primaryColor": "#FF0000",
    "secondaryColor": "#00FF00"
  }
}

Retrieve detailed information for a specific merchant within an organization. Requires ORGANIZATION_SETTINGS_VIEW_MERCHANT permission.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization identifier

merchantIdstringRequired

Merchant identifier

Response

Merchant information retrieved successfully

merchantIdstring

slugstring

profileobject

businessTypestring

businessStructurestring

capabilitiesobject

chargesEnabledboolean

countryIdstring

createdAtdatetime

defaultCurrencyIdstring

kybCompleteboolean

disabledboolean

disabledReasonstring

billingobject

Billing configuration for the merchant

Countryobject

brandingobject

Errors

400

Get Request Bad Request Error

401

Get Request Unauthorized Error

403

Get Request Forbidden Error

404

Get Request Not Found Error

500

Get Request Internal Server Error