Get All Submerchants

GET

https://api-sandbox.coinflow.cash/api/submerchant

GET

/api/submerchant

$ curl https://api-sandbox.coinflow.cash/api/submerchant \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "_id": "642f1b2e9f1b2c0012345678",
4     "merchantId": "mrc_89a7c3d2f1e4b5a6",
5     "kycType": "person",
6     "hideBranding": false,
7     "onlyShowTotal": false,
8     "requireAniCheck": true,
9     "creditSeed": "seed_4f3e2d1c0b9a8e7d6c5b4a3f2e1d0c9b",
10     "enforceJwt": true,
11     "feePayerPublicKey": "FEEpUbLicKeyExample000000000000000000000000",
12     "solanaFeePayerPublicKey": "So1aNaFeePayerKeyExample0000000000000000000",
13     "solanaUsdcPayerPublicKey": "So1aNaUSDCKeyExample000000000000000000000000",
14     "evmFeePayerAddress": "0xFeePayerEvmAddress000000000000000000000000",
15     "evmUsdcPayerAddress": "0xUsdcPayerEvmAddress0000000000000000000000",
16     "stellarUsdcPayerPublicKey": "GB3JD3K6Q7Z5X7Y3L5Q6Z7X5Y3L5Q6Z7X5Y3L5Q6Z7X",
17     "_sanitized": true,
18     "cardSettings": {
19       "avsCheck": true,
20       "requiresKyc": true,
21       "aftEnabled": false,
22       "statementDescriptor": "GreenTech",
23       "saveCardDefault": false,
24       "processor": "payarc",
25       "googlePayProcessor": "payarc",
26       "applePayProcessor": "payarc",
27       "supportsApplePay": true,
28       "supportsGooglePay": true,
29       "tokenizationProvider": "bt"
30     },
31     "achSettings": {
32       "instantSettle": false,
33       "requireKycBeforePurchase": true
34     },
35     "verification": {
36       "status": "approved"
37     },
38     "nSureSettings": {
39       "nSureInsurance": true,
40       "nSureAchInsurance": false,
41       "nSurePartnerId": "partner_12345",
42       "chargebackProtectionType": "insurance"
43     },
44     "canAcceptAch": true,
45     "canAcceptWire": false,
46     "withdrawalGeolocationRequired": false,
47     "checkoutGeolocationRequired": true,
48     "pushToCardEnabled": false,
49     "brand": {
50       "portalBrand": "coinflow",
51       "logo": "https://cdn.coinflow.cash/logos/merchant_logo_123.png",
52       "displayName": "GreenTech Solutions"
53     },
54     "colors": {
55       "showCardIcon": true,
56       "expirationPlaceholder": "MM/YY",
57       "cvvPlaceholder": "123",
58       "cardNumberPlaceholder": "1234 5678 9012 3456",
59       "fontWeight": "bold",
60       "fontSize": "16px",
61       "style": "rounded",
62       "font": "Roboto",
63       "ctaColor": "#4CAF50",
64       "textColorAction": "#FFFFFF",
65       "textColorAccent": "#81C784",
66       "textColor": "#212121",
67       "backgroundAccent2": "#A5D6A7",
68       "backgroundAccent": "#C8E6C9",
69       "background": "#E8F5E9",
70       "primary": "#388E3C"
71     },
72     "url": "https://greentech.example.com",
73     "settlementAddresses": {
74       "solana": "So1aNa1Addre55ExAmplE000000000000000000000",
75       "eth": "0xAbC1234567890DefABC1234567890dEfABc12345",
76       "polygon": "0x1234aBcD5678Ef901234aBcD5678Ef901234aBcD",
77       "base": "0xBaseChainAddressExample000000000000000000",
78       "user": "user_wallet_9876543210",
79       "xion": "XionAddressExample000000000000000000000000",
80       "arbitrum": "0xArbitrumAddressExample0000000000000000000",
81       "stellar": "GB3JD3K6Q7Z5X7Y3L5Q6Z7X5Y3L5Q6Z7X5Y3L5Q6Z7X",
82       "monad": "MonadAddressExample000000000000000000000000",
83       "tempo": "TempoAddressExample0000000000000000000000"
84     },
85     "bankPayoutProvider": [
86       "aptpay"
87     ],
88     "ibanPayoutProviders": [
89       "merge"
90     ],
91     "ibanPayoutProvider": "merge",
92     "rtpPayoutProviders": [
93       "dwolla"
94     ],
95     "rtpPayoutProvider": "dwolla",
96     "pixPayoutProviders": [
97       "brla"
98     ],
99     "pixPayoutProvider": "brla",
100     "eftPayoutProviders": [
101       "checkbook"
102     ],
103     "eftPayoutProvider": "checkbook",
104     "p2cPayoutProviders": [
105       "aptpay"
106     ],
107     "p2cPayoutProvider": "aptpay",
108     "globalP2cPayoutProvider": "aptpay",
109     "appleP2cPayoutProvider": "aptpay",
110     "venmoPayoutProviders": [
111       "checkbook"
112     ],
113     "venmoPayoutProvider": "checkbook",
114     "paypalPayoutProviders": [
115       "checkbook"
116     ],
117     "paypalPayoutProvider": "checkbook",
118     "wirePayoutProvider": [
119       "MOCK"
120     ],
121     "interacPayoutProviders": [
122       "checkbook"
123     ],
124     "interacPayoutProvider": "checkbook",
125     "enforceCheckoutJwt": true,
126     "metakeepAppId": "app_9876543210abcdef",
127     "externalVerificationLinks": true,
128     "whitelistedAncestorUrls": [
129       "https://dashboard.greentech.example.com"
130     ],
131     "enforceLivenessKyc": true,
132     "parent": "parent_merchant_1234567890",
133     "customPayInFees": [
134       {
135         "fee": {
136           "cents": 150,
137           "currency": "USD",
138           "percent": null,
139           "isFixed": true
140         },
141         "lineItemLabel": "Processing Fee"
142       }
143     ],
144     "minTransactionAmount": {
145       "cents": 100
146     },
147     "maxTransactionAmount": {
148       "cents": 1000000
149     },
150     "firstPartyPayoutOverrides": {
151       "interacPayoutProvider": "checkbook",
152       "wirePayoutProvider": [
153         "MOCK"
154       ],
155       "paypalPayoutProvider": "checkbook",
156       "venmoPayoutProvider": "checkbook",
157       "appleP2cPayoutProvider": "aptpay",
158       "globalP2cPayoutProvider": "aptpay",
159       "p2cPayoutProvider": "aptpay",
160       "eftPayoutProvider": "checkbook",
161       "pixPayoutProvider": "brla",
162       "rtpPayoutProvider": "dwolla",
163       "ibanPayoutProvider": "merge",
164       "bankPayoutProvider": [
165         "aptpay"
166       ]
167     }
168   }
169 ]

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

stellarUsdcPayerPublicKeystring

_sanitizedboolean

cardSettingsobject

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

achSettingsobject

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

withdrawalGeolocationRequiredboolean

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

pushToCardEnabledbooleanDeprecated

brandobject

colorsobject

urlstring

settlementAddressesobject

bankPayoutProviderlist of enums

ibanPayoutProviderslist of enums

Allowed values:

ibanPayoutProviderenum

Allowed values:

rtpPayoutProviderslist of enums

rtpPayoutProviderenum

pixPayoutProviderslist of enums

Allowed values:

pixPayoutProviderenum

Allowed values:

eftPayoutProviderslist of enums

Allowed values:

eftPayoutProviderenum

Allowed values:

p2cPayoutProviderslist of enums

Allowed values:

p2cPayoutProviderenum

Allowed values:

globalP2cPayoutProviderenum

Allowed values:

appleP2cPayoutProviderenum

Allowed values:

venmoPayoutProviderslist of enums

Allowed values:

venmoPayoutProviderenum

Allowed values:

paypalPayoutProviderslist of enums

Allowed values:

paypalPayoutProviderenum

Allowed values:

wirePayoutProviderlist of enums

Allowed values:

interacPayoutProviderslist of enums

Allowed values:

interacPayoutProviderenum

Allowed values:

enforceCheckoutJwtboolean

metakeepAppIdstring

externalVerificationLinksboolean

whitelistedAncestorUrlslist of strings

enforceLivenessKycboolean

parentstring

customPayInFeeslist of objects

minTransactionAmountobject

maxTransactionAmountobject

firstPartyPayoutOverridesobjectDeprecated