Get All Submerchants

import requests
url = "https://api-sandbox.coinflow.cash/api/submerchant"
headers = {"Authorization": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "_id": "string",
    "merchantId": "string",
    "kycType": "person",
    "hideBranding": true,
    "onlyShowTotal": true,
    "requireAniCheck": true,
    "creditSeed": "string",
    "enforceJwt": true,
    "feePayerPublicKey": "string",
    "solanaFeePayerPublicKey": "string",
    "solanaUsdcPayerPublicKey": "string",
    "evmFeePayerAddress": "string",
    "evmUsdcPayerAddress": "string",
    "_sanitized": true,
    "cardSettings": {
      "aftEnabled": true,
      "avsCheck": true,
      "applePayProcessor": "payarc",
      "googlePayProcessor": "payarc",
      "processor": "payarc",
      "saveCardDefault": true,
      "statementDescriptor": "string",
      "supportsApplePay": true,
      "supportsGooglePay": true,
      "tokenizationProvider": "bt"
    },
    "achSettings": {
      "instantSettle": true
    },
    "instantSettings": {
      "merchantLegalName": "string"
    },
    "verification": {
      "status": "pending"
    },
    "nSureSettings": {
      "nSureInsurance": true,
      "nSureAchInsurance": true,
      "nSurePartnerId": "string"
    },
    "canAcceptAch": true,
    "canAcceptWire": true,
    "pushToCardEnabled": true,
    "brand": {
      "portalBrand": "approvely",
      "logo": "string",
      "displayName": "string"
    },
    "colors": {
      "style": "rounded",
      "font": "string",
      "ctaColor": "string",
      "textColorAction": "string",
      "textColorAccent": "string",
      "textColor": "string",
      "backgroundAccent2": "string",
      "backgroundAccent": "string",
      "background": "string",
      "primary": "string"
    },
    "url": "string",
    "settlementAddresses": {
      "solana": "string",
      "eth": "string",
      "polygon": "string",
      "base": "string",
      "user": "string",
      "xion": "string",
      "arbitrum": "string",
      "monad": "string"
    },
    "bankPayoutProvider": [
      "aptpay"
    ],
    "ibanPayoutProvider": "merge",
    "rtpPayoutProvider": "dwolla",
    "pixPayoutProvider": "brla",
    "eftPayoutProvider": "cybrid",
    "p2cPayoutProvider": "aptpay",
    "globalP2cPayoutProvider": "aptpay",
    "appleP2cPayoutProvider": "aptpay",
    "venmoPayoutProvider": "checkbook",
    "paypalPayoutProvider": "checkbook",
    "wirePayoutProvider": [
      "MOCK"
    ],
    "interacPayoutProvider": "checkbook",
    "enforceCheckoutJwt": true,
    "metakeepAppId": "string",
    "externalVerificationLinks": true,
    "whitelistedAncestorUrls": [
      "string"
    ],
    "enforceLivenessKyc": true,
    "parent": "string"
  }
]

Authentication

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Query parameters

pagedoubleOptionalDefaults to 1

limitdoubleOptionalDefaults to 100

searchstringOptional

Response

_idstring

merchantIdstring

kycTypeenum

Allowed values:

hideBrandingboolean

onlyShowTotalboolean

requireAniCheckboolean

creditSeedstring

enforceJwtboolean

feePayerPublicKeystring

solanaFeePayerPublicKeystring

solanaUsdcPayerPublicKeystring

evmFeePayerAddressstring

evmUsdcPayerAddressstring

_sanitizedboolean

cardSettingsobject

achSettingsobject

From T, pick a set of properties whose keys are in the union K

instantSettingsobject

From T, pick a set of properties whose keys are in the union K

verificationobject

From T, pick a set of properties whose keys are in the union K

nSureSettingsobject

From T, pick a set of properties whose keys are in the union K

canAcceptAchboolean

canAcceptWireboolean

pushToCardEnabledbooleanDeprecated

brandobject or null

colorsobject or null

urlstring or null

settlementAddressesobject or null

bankPayoutProviderlist of enums or null

ibanPayoutProviderenum or null

Allowed values:

rtpPayoutProviderenum or null

pixPayoutProviderenum or null

Allowed values:

eftPayoutProviderenum or null

Allowed values:

p2cPayoutProviderenum or null

Allowed values:

globalP2cPayoutProviderenum or null

Allowed values:

appleP2cPayoutProviderenum or null

Allowed values:

venmoPayoutProviderenum or null

Allowed values:

paypalPayoutProviderenum or null

Allowed values:

wirePayoutProviderlist of enums or null

Allowed values:

interacPayoutProviderenum or null

Allowed values:

enforceCheckoutJwtboolean or null

metakeepAppIdstring or null

externalVerificationLinksboolean or null

whitelistedAncestorUrlslist of strings or null

enforceLivenessKycboolean or null

parentstring or null