subMerchant

Get All Submerchants

Changed on
get/submerchant

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/submerchant
  • Auth
    API key in header Authorization

Query parameters

pagenumber double
limitnumber double
searchstring

Response

Ok

_idstring required
merchantIdstring required
urlstring
kycType'person' | 'business' | 'both' required
hideBrandingboolean required
onlyShowTotalboolean required
requireAniCheckboolean required
bankPayoutProviderPayoutProviderOption[]
ibanPayoutProvidersIbanPayoutProvider[]
swiftPayoutProvidersSwiftPayoutProvider[]
rtpPayoutProvidersRtpPayoutProvider[]
pixPayoutProvidersPixPayoutProvider[]
eftPayoutProvidersEftPayoutProvider[]
p2cPayoutProvidersCardPayoutProvider[]
ibanPayoutProvider'merge' | 'mock' | 'ivy'
rtpPayoutProvider'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale'
pixPayoutProvider'avenia' | 'brla' | 'mock'
eftPayoutProvider'checkbook' | 'aptpay' | 'mock'
p2cPayoutProvider'aptpay' | 'checkbook' | 'shift4' | 'citcon' | 'crb' | 'MOCK'
globalP2cPayoutProvider'aptpay' | 'checkbook' | 'shift4' | 'citcon' | 'crb' | 'MOCK'
appleP2cPayoutProvider'aptpay' | 'MOCK'
venmoPayoutProvidersVenmoPayoutProvider[]
paypalPayoutProvidersPayPalPayoutProvider[]
venmoPayoutProvider'checkbook' | 'citcon' | 'mock' | 'paypal'
paypalPayoutProvider'checkbook' | 'citcon' | 'mock' | 'paypal'
wirePayoutProviderWirePayoutProvider[]
cryptoPayoutProvidersCryptoPayoutProvider[]
interacPayoutProvidersInteracPayoutProvider[]
interacPayoutProvider'checkbook' | 'mock' | 'aptpay'
interacPaymentProvider'mock' | 'aptpay'
enforceJwtboolean required
enforceCheckoutJwtboolean
externalVerificationLinksboolean
whitelistedAncestorUrlsstring[]
pushToCardEnabledboolean required
creditSeedstring required
enforceLivenessKycboolean
kycMinAgenumber double
supportEmailstring
feePayerPublicKeystring required
solanaFeePayerPublicKeystring required
solanaUsdcPayerPublicKeystring required
evmFeePayerAddressstring required
evmUsdcPayerAddressstring required
stellarUsdcPayerPublicKeystring required
_sanitizedboolean required
__vnumber double
parentstring
canAcceptAchboolean required
canAcceptWireboolean required
withdrawalGeolocationRequiredboolean 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.

checkoutGeolocationRequiredboolean required
paypalRequireLoginboolean 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.

paypalMerchantIdstring
paypalClientIdstring

Changes

    • warning

      added the new crb enum value to the // response property for the response status

    • warning

      added the new crb enum value to the // response property for the response status

    • warning

      added the new crb enum value to the / response property for the response status

    • warning

      added the new crb enum value to the / response property for the response status

    • warning

      added the new crb enum value to the // response property for the response status

    • info

      removed the merchant_warrior enum value from the // response property for the response status

    • info

      removed the merchant_warrior enum value from the // response property for the response status

    • info

      removed the merchant_warrior enum value from the // response property for the response status

    • warning

      added the new ev enum value to the // response property for the response status