---
title: "Fetch Merchant"
method: GET
path: "/api/merchant"
tags: ["Enrollment"]
---

# Fetch Merchant

`GET /api/merchant`

Get an individual merchant from your chargeblast account.

## Query parameters

- `merchant_id` string, nullable

## Headers

- `X-API-Key` string, required

## Response `200`

OK

- PayshieldRetailerDTO
  - `sites` PayshieldSiteDTO[], required
    - `retailer` PayshieldRetailerDTO, required — recursive
    - `descriptors` PayshieldDescriptorDTO[], required
      - `id` string, nullable
      - `hasEmailSent` boolean, required
      - `type` 'Ethoca' | 'CDRN' | 'RDR' | 'Discover' | 'AMEX' | 'JCB' | 'Unknown' | '', required
      - `bankMid` string, nullable
      - `status` 'Pending' | 'Enrolled' | 'Disabled' | 'Surpressed' | 'Processing' | 'Rejected' | 'InReview' | 'PendingRemoval', required — Descriptor lifecycle state. `PendingRemoval` means an unenroll was requested for a previously `Enrolled` descriptor; it stays live until provider de-registration is confirmed, then the record is deleted.
      - `site` PayshieldSiteDTO, required — recursive
      - `details` DescriptorDetails, required
        - `type` string, required
    - `id` string, nullable
    - `name` string, required
  - `name` string, nullable
  - `rcode` string, nullable
  - `user` UserDTO, required
    - `hubspotId` string, nullable
    - `pfStripeId` string, nullable
    - `tokens` RutterTokenDTO[], required
      - `externalId` string, nullable
      - `connectionId` string, required
      - `accessToken` string, required
      - `platformToken` string, nullable
      - `id` string, nullable
      - `storeUniqueName` string, required
      - `isReady` boolean, required
      - `status` 'active' | 'inactive', required
      - `publicToken` string, required
      - `platform` string, required
    - `svixId` string, nullable
    - `id` string, nullable
    - `fromInvite` boolean, nullable
    - `referralCode` string, nullable
    - `merchantId` string, nullable
    - `phonenumber` string, nullable
    - `stripeId` string, nullable
    - `utmSource` string, nullable
    - `agentDeal` AgentDealDTO[], required
      - `agentPayload` object, required
      - `id` string, nullable
      - `createdAt` string, date-time, nullable
    - `internalCompany` string, nullable
    - `invitations` InvitationDTO[], required
      - `email` string, required
      - `status` 'Pending' | 'Accepted'
      - `id` string, nullable
      - `createdAt` string, date-time, nullable
      - `permission` 'manager' | 'analyst' | 'admin' | 'refundAnalyst' | 'any' | 'unknown', required
    - `announcements` AnnouncementDTO[], required
      - `message` string, required
      - `id` string, nullable
      - `type` 'Error' | 'Warning' | 'Success', required
    - `accounts` CBAccountDTO[], required
      - `id` string, nullable
      - `email` string, nullable
    - `isBilledForResolved` boolean, nullable
    - `risk` 'High' | 'Medium' | 'Low'
    - `internalId` string, nullable
    - `email` string, nullable
    - `settings` UserSettingsDTO
      - `id` string, nullable
      - `settings` Settings
        - `webhooks` string[], required
        - `processor` string, nullable
        - `ruleset` string, nullable
        - `descriptors` string[], nullable
        - `refundUrl` string, nullable
        - `autoresolve` boolean, nullable
        - `integrationSettings` IntegrationSettings
          - `mamopayIntegration` MamopayIntegration
            - `enabled` boolean, nullable
            - `apiKey` string, nullable
          - `braintreeIntegration` BraintreeIntegration
            - `privateKey` string, nullable
            - `enabled` boolean, nullable
            - `accountId` string, nullable
            - `merchantId` string, nullable
            - `publicKey` string, nullable
          - `sealIntegration` SealIntegration
            - `enabled` boolean, required
            - `apiKey` string, required
          - `checkoutChampIntegration` CheckoutChampIntegration
            - `password` string, required
            - `enabled` boolean, required
            - `username` string, required
          - `stripeIntegration` StripeIntegration
            - `account_id` string, required
            - `user_id` string, nullable
            - `shouldAppendDescriptor` boolean, nullable
            - `testMode` boolean, nullable
            - `enabled` boolean, required
            - `state` string, nullable
            - `useBillingDescriptors` boolean, nullable
            - `appendDescriptor` string, nullable
          - `skioIntegration` SkioIntegration
            - `enabled` boolean, nullable
            - `apiKey` string, nullable
          - `discordIntegration` DiscordIntegration
            - `webhook` string, required
            - `enabled` boolean, required
          - `stickyIntegration` StickyIntegration
            - `enabled` boolean, nullable
            - `subdomain` string, nullable
            - `username` string, nullable
            - `password` string, nullable
          - `shopifyIntegration` ShopifyIntegration
            - `id` string, nullable
            - `store_unique_name` string, nullable
            - `state` string, nullable
            - `external_id` string, nullable
          - `nextIntegration` NextIntegration
            - `status` string, nullable
            - `store` string, nullable
            - `enabled` boolean, nullable
          - `maverickIntegration` MaverickIntegration
            - `enabled` boolean, nullable
            - `apiKey` string, nullable
          - `spreedlyIntegration` SpreedlyIntegration
            - `env` string, nullable
            - `enabled` boolean, nullable
            - `key` string, nullable
          - `smsIntegration` SMSIntegration
            - `phonenumber` string, required
            - `enabled` boolean, required
          - `whopIntegration` WhopIntegration
            - `userId` string, required
            - `enabled` boolean, required
            - `paymentStatus` string, nullable
            - `companyId` string, required
          - `slackIntegration` SlackIntegration
            - `enabled` boolean, required
            - `channel` string, required
            - `authCode` string, required
          - `klaviyoIntegration` KlaviyoIntegration
            - `enabled` boolean, required
            - `apiKey` string, required
        - `arns` string[], nullable
        - `accountBanned` boolean, nullable
        - `alertColumns` string[], nullable
        - `mcc` string, nullable
        - `refundAllFromCustomer` boolean, nullable
        - `cancelSubscription` boolean, nullable
        - `addCustomerToBlockList` boolean, nullable
        - `descriptorRules` Rule[], nullable
          - `action` RuleAction
            - `descriptor` string, nullable
          - `rules` RuleGroup[], required
            - `logicOperator` string, required
        - `apiKey` string, required
        - `paymentSource` string, nullable
        - `emails` string[], required
        - `invoiceSettings` InvoiceSettings
          - `vatCode` string, nullable
          - `postal_code` string, nullable
          - `line2` string, nullable
          - `line1` string, nullable
          - `state` string, nullable
          - `country` string, nullable
          - `vatNumber` string, nullable
          - `city` string, nullable
        - `selectedAlerts` string[], nullable
        - `rdrNotifications` boolean, nullable
        - `agentSettings` AgentSettings
          - `bankTransferInfo` AgentSettingsBankTransferInfo, required
            - `bankAddress` string, nullable
            - `bankName` string, nullable
            - `enabled` boolean, required
            - `routingNumber` string, nullable
            - `iban` string, nullable
            - `swiftCode` string, nullable
            - `accountNumber` string, nullable
          - `cryptoInfo` AgentSettingsCryptoInfo, required
            - `token` string, required
        - `claritySettings` ClaritySettings
          - `websiteForReceipt` string, nullable
          - `productDescription` string, nullable
          - `cancellationPolicy` string, nullable
          - `termsAndConditionsLink` string, nullable
          - `merchantCategoryCode` string, nullable
          - `cancellationPolicyRecap` string, nullable
          - `termsAndConditions` string, nullable
          - `cancellationPolicyLink` string, nullable
          - `country` string, nullable
          - `latitude` string, nullable
          - `logoUrl` string, nullable
          - `phoneForReceipt` string, nullable
          - `termsAndConditionsRecap` string, nullable
          - `line1` string, nullable
          - `city` string, nullable
          - `status` string, nullable
          - `productName` string, nullable
          - `countrySubdivision` string, nullable
          - `description` string, nullable
          - `name` string, nullable
          - `postalCode` string, nullable
          - `refundPolicyLink` string, nullable
          - `refundPolicyRecap` string, nullable
          - `refundPolicy` string, nullable
          - `longitude` string, nullable
          - `emailForReceipt` string, nullable
          - `line2` string, nullable
        - `touched` integer, nullable
        - `webhookSecret` string, nullable
        - `matchingThreshhold` number, double, nullable
        - `threshholdEnabled` boolean, nullable
        - `efwRule` Rule
          - `action` RuleAction
            - `descriptor` string, nullable
          - `rules` RuleGroup[], required
            - `logicOperator` string, required
        - `ethocaRule` Rule
          - `action` RuleAction
            - `descriptor` string, nullable
          - `rules` RuleGroup[], required
            - `logicOperator` string, required
        - `refundAPIEnabled` boolean, nullable
        - `hasBetaFeatures` boolean, nullable
    - `createdAt` string, date-time, nullable
    - `name` string, nullable
    - `company` string, nullable
    - `admin` boolean, nullable
    - `isSalesAgent` boolean, nullable
  - `verifiRiskLevel` 'High' | 'Medium' | 'Low'
  - `verifi_name` string, nullable
  - `source` 'Banks' | 'Ethoca' | 'Verifi'
  - `merchant_id` string, nullable
  - `id` string, nullable

---

[API](https://skmtc.net/chargeblast/apis/chargeblast-api.md) · [All operations](https://skmtc.net/chargeblast/apis/chargeblast-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chargeblast/chargeblast-api/versions/9cc519753b33/schema)