Sign in

v4

latestOpenAPI 3.1.02026-08-08186985685.3 KB
subMerchant

Get All Submerchants

get/submerchant

Query parameters

pagenumber double
limitnumber double
searchstring

Headers

Authorizationstring required

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

Response

Ok

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