--- title: "Get All Submerchants" method: GET path: "/submerchant" tags: ["subMerchant"] --- # Get All Submerchants `GET /submerchant` ## Query parameters - `page` number, double - `limit` number, double - `search` string ## Headers - `Authorization` string, required ## Response `200` Ok - SanitizedMerchant[] - `_id` string, required - `merchantId` string, required - `brand` MerchantBrandSettings - `portalBrand` 'approvely' | 'seamlesschex' | 'coinflow' | 'yourbrandhere' | 'Plan2Play' | 'tango' | 'interlace' | 'tapvia' - `logo` string - `displayName` string - `colors` MerchantTheme - `showCardIcon` boolean - `placeholderColor` string - `expirationPlaceholder` string - `cvvPlaceholder` string - `cardNumberPlaceholder` string - `fontWeight` string - `fontSize` string - `style` 'rounded' | 'sharp' | 'pill' - `font` string - `ctaColor` string - `textColorAction` string - `textColorAccent` string - `textColor` string - `backgroundAccent2` string - `backgroundAccent` string - `cardBackground` string - `background` string - `primary` string - `url` string - `kycType` 'person' | 'business' | 'both', required - `settlementAddresses` SanitizedMerchantSettlementAddresses - `solana` string - `eth` string - `polygon` string - `base` string - `user` string - `arbitrum` string - `stellar` string - `monad` string - `tempo` string - `hideBranding` boolean, required - `onlyShowTotal` boolean, required - `pushToCardEnabled` boolean, required - `requireAniCheck` boolean, required - `bankPayoutProvider` PayoutProviderOption[] - `ibanPayoutProviders` IbanPayoutProvider[] - `swiftPayoutProviders` SwiftPayoutProvider[] - `ibanPayoutProvider` 'merge' | 'mock' | 'ivy' - `rtpPayoutProviders` RtpPayoutProvider[] - `rtpPayoutProvider` 'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale' - `pixPayoutProviders` PixPayoutProvider[] - `pixPayoutProvider` 'brla' | 'mock' - `eftPayoutProviders` EftPayoutProvider[] - `eftPayoutProvider` 'checkbook' | 'aptpay' | 'mock' - `p2cPayoutProviders` CardPayoutProvider[] - `p2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `globalP2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `appleP2cPayoutProvider` 'aptpay' | 'MOCK' - `venmoPayoutProviders` VenmoPayoutProvider[] - `venmoPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `paypalPayoutProviders` PayPalPayoutProvider[] - `paypalPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `wirePayoutProvider` WirePayoutProvider[] - `interacPayoutProviders` InteracPayoutProvider[] - `interacPayoutProvider` 'checkbook' | 'mock' | 'aptpay' - `interacPaymentProvider` 'mock' | 'aptpay' - `interacSettings` InteracSettings, required - `processor` 'mock' | 'aptpay' - `feeMode` 'user' | 'merchant' | 'invoice' - `fxFeeMode` 'user' | 'merchant' | 'invoice' - `fixedFee` Cents - `cents` integer, required - `feeBps` number, double - `minFee` Cents - `cents` integer, required - `customerEmailNotifications` boolean, required - `merchantEmailNotifications` boolean, required - `firstPartyPayoutOverrides` SanitizedMerchantFirstPartyPayoutOverrides - `interacPayoutProvider` 'checkbook' | 'mock' | 'aptpay' - `wirePayoutProvider` WirePayoutProvider[] - `paypalPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `venmoPayoutProvider` 'checkbook' | 'citcon' | 'mock' | 'paypal' - `appleP2cPayoutProvider` 'aptpay' | 'MOCK' - `globalP2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `p2cPayoutProvider` 'aptpay' | 'checkbook' | 'shift4' | 'MOCK' - `eftPayoutProvider` 'checkbook' | 'aptpay' | 'mock' - `pixPayoutProvider` 'brla' | 'mock' - `rtpPayoutProvider` 'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale' - `ibanPayoutProvider` 'merge' | 'mock' | 'ivy' - `bankPayoutProvider` PayoutProviderOption[] - `creditSeed` string, required - `enforceJwt` boolean, required - `enforceCheckoutJwt` boolean - `externalVerificationLinks` boolean - `whitelistedAncestorUrls` string[] - `enforceLivenessKyc` boolean - `kycMinAge` number, double - `feePayerPublicKey` string, required - `solanaFeePayerPublicKey` string, required - `solanaUsdcPayerPublicKey` string, required - `evmFeePayerAddress` string, required - `evmUsdcPayerAddress` string, required - `stellarUsdcPayerPublicKey` string, required - `_sanitized` boolean, required - `parent` string - `customPayInFees` CustomPayInFeeConfig[] - `fee` union, required - CustomPayInFeeValue0 - `cents` number, double, required - `currency` 'USD' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'GBP' | 'GEL' | 'GHS' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MWK' | 'MVR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'CDF' | 'ERN' | 'FKP' | 'KPW' | 'RUB' | 'SBD' | 'SHP' | 'SSP' | 'VES', required - `percent` number, double, nullable, required - `isFixed` boolean, required - CustomPayInFeeValue1 - `cents` number, double, nullable, required - `currency` number, double, nullable, required - `percent` number, double, required - `isFixed` boolean, required - `lineItemLabel` string, required - `cardSettings` SanitizedMerchantCardSettings, required — From T, pick a set of properties whose keys are in the union K - `statementDescriptor` string - `saveCardDefault` boolean - `processor` 'payarc' | 'mock' | 'shift4' | 'merchant_warrior' | 'greenlight' | 'nmi_direct' | 'mvb' | 'fifththird' | 'natwest' | 'crb' | 'highnote' | 'nuveiv1' | 'koard' | 'fallback_payarc_shift4' | 'fallback_shift4_payarc' | 'fallback_shift4_nuvei' | 'fallback_nuvei_payarc' | 'fallback_payarc_nuvei' | 'fallback_shift4_greenlight' | 'fallback_greenlight_shift4' | 'fallback_natwest_shift4' | 'fallback_natwest_nuvei' | 'fallback_natwest_shift4_payarc' | 'fallback_natwest_shift4_nuvei' | 'fallback_shift4_natwest_payarc' | 'fallback_nuvei_natwest_payarc' | 'fallback_natwest_nuvei_payarc' | 'fallback_mvb_fifththird_shift4_payarc' | 'fallback_fifththird_mvb_shift4_payarc' | 'fallback_mvb_nuvei' | 'fallback_nuvei_fifththird' | 'fallback_fifththird_nuvei' - `googlePayProcessor` 'payarc' | 'mock' | 'shift4' | 'merchant_warrior' | 'greenlight' | 'nmi_direct' | 'mvb' | 'fifththird' | 'natwest' | 'crb' | 'highnote' | 'nuveiv1' | 'koard' | 'fallback_payarc_shift4' | 'fallback_shift4_payarc' | 'fallback_shift4_nuvei' | 'fallback_nuvei_payarc' | 'fallback_payarc_nuvei' | 'fallback_shift4_greenlight' | 'fallback_greenlight_shift4' | 'fallback_natwest_shift4' | 'fallback_natwest_nuvei' | 'fallback_natwest_shift4_payarc' | 'fallback_natwest_shift4_nuvei' | 'fallback_shift4_natwest_payarc' | 'fallback_nuvei_natwest_payarc' | 'fallback_natwest_nuvei_payarc' | 'fallback_mvb_fifththird_shift4_payarc' | 'fallback_fifththird_mvb_shift4_payarc' | 'fallback_mvb_nuvei' | 'fallback_nuvei_fifththird' | 'fallback_fifththird_nuvei' - `applePayProcessor` 'payarc' | 'mock' | 'shift4' | 'merchant_warrior' | 'greenlight' | 'nmi_direct' | 'mvb' | 'fifththird' | 'natwest' | 'crb' | 'highnote' | 'nuveiv1' | 'koard' | 'fallback_payarc_shift4' | 'fallback_shift4_payarc' | 'fallback_shift4_nuvei' | 'fallback_nuvei_payarc' | 'fallback_payarc_nuvei' | 'fallback_shift4_greenlight' | 'fallback_greenlight_shift4' | 'fallback_natwest_shift4' | 'fallback_natwest_nuvei' | 'fallback_natwest_shift4_payarc' | 'fallback_natwest_shift4_nuvei' | 'fallback_shift4_natwest_payarc' | 'fallback_nuvei_natwest_payarc' | 'fallback_natwest_nuvei_payarc' | 'fallback_mvb_fifththird_shift4_payarc' | 'fallback_fifththird_mvb_shift4_payarc' | 'fallback_mvb_nuvei' | 'fallback_nuvei_fifththird' | 'fallback_fifththird_nuvei' - `supportsApplePay` boolean - `supportsGooglePay` boolean - `tokenizationProvider` 'bt' | 'tokenex' - `avsCheck` boolean, required - `requiresKyc` boolean, required - `aftEnabled` boolean, required - `achSettings` PickACHSettingsInstantSettleOrRequireKycBeforePurchase, required — From T, pick a set of properties whose keys are in the union K - `instantSettle` boolean, required - `requireKycBeforePurchase` boolean - `verification` PickVerificationStatus, required — From T, pick a set of properties whose keys are in the union K - `status` 'pending' | 'partial-approval' | 'approved' | 'rejected' | 'expired', required - `canAcceptAch` boolean, required - `canAcceptWire` boolean, required - `minTransactionAmount` Cents - `cents` integer, required - `maxTransactionAmount` Cents - `cents` integer, required - `withdrawalGeolocationRequired` boolean, required — Authoritative: derived from the merchant's blockingRules. The frontend uses this to decide whether to prompt for geolocation; the backend enforces independently via the same rules. - `checkoutGeolocationRequired` boolean, required - `paypalRequireLogin` boolean, required — Authoritative: whether new PayPal payout accounts must be linked via Log in with PayPal (derived from paypalSettings.requireLogin). The frontend uses this to force the login flow; the backend enforces independently. - `paypalMerchantId` string - `paypalClientId` string --- [API](https://skmtc.net/coinflow/apis/api-reference.md) · [All operations](https://skmtc.net/coinflow/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coinflow/api-reference/versions/7eea51c8775d/schema)