Get Submerchant by ID

GET

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

GET

/api/submerchant/:submerchantId

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

1 {
2   "_id": "63f9a8b2e4b0c123456789ab",
3   "merchantId": "mrc_9876543210abcdef",
4   "kycType": "person",
5   "hideBranding": false,
6   "onlyShowTotal": false,
7   "requireAniCheck": true,
8   "interacSettings": {
9     "paysFees": true,
10     "paysFxFees": true,
11     "customerEmailNotifications": true,
12     "merchantEmailNotifications": true,
13     "processor": "mock",
14     "fixedFee": {
15       "cents": 50
16     },
17     "feeBps": 15.5,
18     "minFee": {
19       "cents": 100
20     }
21   },
22   "creditSeed": "a1b2c3d4e5f67890123456789abcdef0",
23   "enforceJwt": true,
24   "feePayerPublicKey": "FEEp4y3rPub1icKeyExample1234567890",
25   "solanaFeePayerPublicKey": "So1anaFeePayerPubKeyExample1234567890",
26   "solanaUsdcPayerPublicKey": "So1anaUSDCp4yerPubKeyExample0987654321",
27   "evmFeePayerAddress": "0xFeePayerEvmAddress1234567890abcdef",
28   "evmUsdcPayerAddress": "0xUsdcPayerEvmAddressabcdef1234567890",
29   "stellarUsdcPayerPublicKey": "GB3JZ5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6",
30   "_sanitized": true,
31   "cardSettings": {
32     "avsCheck": true,
33     "requiresKyc": true,
34     "aftEnabled": false,
35     "statementDescriptor": "COINFLOW*STORE123",
36     "saveCardDefault": false,
37     "processor": "payarc",
38     "googlePayProcessor": "payarc",
39     "applePayProcessor": "payarc",
40     "supportsApplePay": true,
41     "supportsGooglePay": true,
42     "tokenizationProvider": "bt"
43   },
44   "achSettings": {
45     "instantSettle": false,
46     "requireKycBeforePurchase": true
47   },
48   "verification": {
49     "status": "approved"
50   },
51   "nSureSettings": {
52     "nSureInsurance": true,
53     "nSureAchInsurance": false,
54     "nSurePartnerId": "nsure_partner_789",
55     "chargebackProtectionType": "insurance"
56   },
57   "canAcceptAch": true,
58   "canAcceptWire": false,
59   "withdrawalGeolocationRequired": false,
60   "checkoutGeolocationRequired": true,
61   "pushToCardEnabled": false,
62   "brand": {
63     "portalBrand": "coinflow",
64     "logo": "https://cdn.coinflow.cash/logos/merchant123.png",
65     "displayName": "CoinFlow Store"
66   },
67   "colors": {
68     "showCardIcon": true,
69     "placeholderColor": "#cccccc",
70     "expirationPlaceholder": "MM/YY",
71     "cvvPlaceholder": "123",
72     "cardNumberPlaceholder": "1234 5678 9012 3456",
73     "fontWeight": "bold",
74     "fontSize": "14px",
75     "style": "rounded",
76     "font": "Roboto",
77     "ctaColor": "#0070f3",
78     "textColorAction": "#ffffff",
79     "textColorAccent": "#ff9900",
80     "textColor": "#333333",
81     "backgroundAccent2": "#f5f5f5",
82     "backgroundAccent": "#e0e0e0",
83     "cardBackground": "#ffffff",
84     "background": "#fafafa",
85     "primary": "#0055cc"
86   },
87   "url": "https://merchant.coinflow.cash/store123",
88   "settlementAddresses": {
89     "solana": "So1ana1Sett1ementAddr3ssXyz123",
90     "eth": "0xAbC1234567890DefABC1234567890dEfABc12345",
91     "polygon": "0xPolygonSettlementAddress1234567890abcdef",
92     "base": "0xBaseSettlementAddress1234567890abcdef",
93     "user": "user_settlement_address_001",
94     "xion": "xion_settlement_address_abc123",
95     "arbitrum": "0xArbitrumSettlementAddress1234567890",
96     "stellar": "GB3JZ5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6Y3X7Z5Q6",
97     "monad": "monad_settlement_address_987654321",
98     "tempo": "tempo_settlement_address_xyz987"
99   },
100   "bankPayoutProvider": [
101     "aptpay"
102   ],
103   "ibanPayoutProviders": [
104     "merge"
105   ],
106   "ibanPayoutProvider": "merge",
107   "rtpPayoutProviders": [
108     "dwolla"
109   ],
110   "rtpPayoutProvider": "dwolla",
111   "pixPayoutProviders": [
112     "brla"
113   ],
114   "pixPayoutProvider": "brla",
115   "eftPayoutProviders": [
116     "checkbook"
117   ],
118   "eftPayoutProvider": "checkbook",
119   "p2cPayoutProviders": [
120     "aptpay"
121   ],
122   "p2cPayoutProvider": "aptpay",
123   "globalP2cPayoutProvider": "aptpay",
124   "appleP2cPayoutProvider": "aptpay",
125   "venmoPayoutProviders": [
126     "checkbook"
127   ],
128   "venmoPayoutProvider": "checkbook",
129   "paypalPayoutProviders": [
130     "checkbook"
131   ],
132   "paypalPayoutProvider": "checkbook",
133   "wirePayoutProvider": [
134     "MOCK"
135   ],
136   "interacPayoutProviders": [
137     "checkbook"
138   ],
139   "interacPayoutProvider": "checkbook",
140   "interacPaymentProvider": "mock",
141   "enforceCheckoutJwt": false,
142   "metakeepAppId": "metakeep_app_123456",
143   "externalVerificationLinks": false,
144   "whitelistedAncestorUrls": [
145     "https://trustedpartner.com",
146     "https://affiliate.coinflow.cash"
147   ],
148   "enforceLivenessKyc": true,
149   "parent": "parent_merchant_001",
150   "customPayInFees": [
151     {
152       "fee": {
153         "cents": 150,
154         "currency": "USD",
155         "percent": null,
156         "isFixed": true
157       },
158       "lineItemLabel": "Processing Fee"
159     }
160   ],
161   "minTransactionAmount": {
162     "cents": 100
163   },
164   "maxTransactionAmount": {
165     "cents": 1000000
166   },
167   "paypalMerchantId": "paypal_merchant_123456",
168   "firstPartyPayoutOverrides": {
169     "interacPayoutProvider": "checkbook",
170     "wirePayoutProvider": [
171       "MOCK"
172     ],
173     "paypalPayoutProvider": "checkbook",
174     "venmoPayoutProvider": "checkbook",
175     "appleP2cPayoutProvider": "aptpay",
176     "globalP2cPayoutProvider": "aptpay",
177     "p2cPayoutProvider": "aptpay",
178     "eftPayoutProvider": "checkbook",
179     "pixPayoutProvider": "brla",
180     "rtpPayoutProvider": "dwolla",
181     "ibanPayoutProvider": "merge",
182     "bankPayoutProvider": [
183       "aptpay"
184     ]
185   }
186 }

Authentication

Authorizationstring

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

Path parameters

submerchantIdstringRequired

Response

_idstring

merchantIdstring

kycTypeenum

hideBrandingboolean

onlyShowTotalboolean

requireAniCheckboolean

interacSettingsobject

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

ibanPayoutProviderenum

rtpPayoutProviderslist of enums

rtpPayoutProviderenum

pixPayoutProviderslist of enums

pixPayoutProviderenum

eftPayoutProviderslist of enums

eftPayoutProviderenum

p2cPayoutProviderslist of enums

p2cPayoutProviderenum

globalP2cPayoutProviderenum

appleP2cPayoutProviderenum

venmoPayoutProviderslist of enums

venmoPayoutProviderenum

paypalPayoutProviderslist of enums

paypalPayoutProviderenum

wirePayoutProviderlist of enums

interacPayoutProviderslist of enums

interacPayoutProviderenum

interacPaymentProviderenum

enforceCheckoutJwtboolean

metakeepAppIdstring

externalVerificationLinksboolean

whitelistedAncestorUrlslist of strings

enforceLivenessKycboolean

parentstring

customPayInFeeslist of objects

minTransactionAmountobject

maxTransactionAmountobject

paypalMerchantIdstring

firstPartyPayoutOverridesobjectDeprecated

Errors

404

Not Found Error