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>"

1 {
2   "_id": "string",
3   "merchantId": "string",
4   "kycType": "person",
5   "hideBranding": true,
6   "onlyShowTotal": true,
7   "requireAniCheck": true,
8   "interacSettings": {
9     "customerEmailNotifications": true,
10     "merchantEmailNotifications": true,
11     "rebateBps": 1.1,
12     "rebateFixed": {
13       "cents": 1
14     },
15     "processor": "mock",
16     "feeMode": "user",
17     "fxFeeMode": "user",
18     "fixedFee": {
19       "cents": 1
20     },
21     "feeBps": 1.1,
22     "minFee": {
23       "cents": 1
24     }
25   },
26   "creditSeed": "string",
27   "enforceJwt": true,
28   "feePayerPublicKey": "string",
29   "solanaFeePayerPublicKey": "string",
30   "solanaUsdcPayerPublicKey": "string",
31   "evmFeePayerAddress": "string",
32   "evmUsdcPayerAddress": "string",
33   "stellarUsdcPayerPublicKey": "string",
34   "_sanitized": true,
35   "cardSettings": {
36     "avsCheck": true,
37     "requiresKyc": true,
38     "aftEnabled": true,
39     "statementDescriptor": "string",
40     "saveCardDefault": true,
41     "processor": "payarc",
42     "googlePayProcessor": "payarc",
43     "applePayProcessor": "payarc",
44     "supportsApplePay": true,
45     "supportsGooglePay": true,
46     "tokenizationProvider": "bt",
47     "debitOnly": true
48   },
49   "achSettings": {
50     "instantSettle": true,
51     "requireKycBeforePurchase": true
52   },
53   "verification": {
54     "status": "pending"
55   },
56   "canAcceptAch": true,
57   "canAcceptWire": true,
58   "withdrawalGeolocationRequired": true,
59   "checkoutGeolocationRequired": true,
60   "paypalRequireLogin": true,
61   "pushToCardEnabled": true,
62   "brand": {
63     "portalBrand": "approvely",
64     "logo": "string",
65     "displayName": "string"
66   },
67   "colors": {
68     "showCardIcon": true,
69     "placeholderColor": "string",
70     "expirationPlaceholder": "string",
71     "cvvPlaceholder": "string",
72     "cardNumberPlaceholder": "string",
73     "fontWeight": "string",
74     "fontSize": "string",
75     "style": "rounded",
76     "font": "string",
77     "ctaColor": "string",
78     "textColorAction": "string",
79     "textColorAccent": "string",
80     "textColor": "string",
81     "backgroundAccent2": "string",
82     "backgroundAccent": "string",
83     "cardBackground": "string",
84     "background": "string",
85     "primary": "string"
86   },
87   "url": "string",
88   "supportEmail": "string",
89   "settlementAddresses": {
90     "solana": "string",
91     "eth": "string",
92     "polygon": "string",
93     "base": "string",
94     "user": "string",
95     "arbitrum": "string",
96     "stellar": "string",
97     "monad": "string",
98     "tempo": "string"
99   },
100   "bankPayoutProvider": [
101     "aptpay"
102   ],
103   "ibanPayoutProviders": [
104     "merge"
105   ],
106   "swiftPayoutProviders": [
107     "manual"
108   ],
109   "ibanPayoutProvider": "merge",
110   "rtpPayoutProviders": [
111     "dwolla"
112   ],
113   "rtpPayoutProvider": "dwolla",
114   "pixPayoutProviders": [
115     "avenia"
116   ],
117   "pixPayoutProvider": "avenia",
118   "eftPayoutProviders": [
119     "checkbook"
120   ],
121   "eftPayoutProvider": "checkbook",
122   "p2cPayoutProviders": [
123     "aptpay"
124   ],
125   "p2cPayoutProvider": "aptpay",
126   "globalP2cPayoutProvider": "aptpay",
127   "appleP2cPayoutProvider": "aptpay",
128   "venmoPayoutProviders": [
129     "checkbook"
130   ],
131   "venmoPayoutProvider": "checkbook",
132   "paypalPayoutProviders": [
133     "checkbook"
134   ],
135   "paypalPayoutProvider": "checkbook",
136   "wirePayoutProvider": [
137     "MOCK"
138   ],
139   "cryptoPayoutProviders": [
140     "glide"
141   ],
142   "interacPayoutProviders": [
143     "checkbook"
144   ],
145   "interacPayoutProvider": "checkbook",
146   "interacPaymentProvider": "mock",
147   "enforceCheckoutJwt": true,
148   "externalVerificationLinks": true,
149   "whitelistedAncestorUrls": [
150     "string"
151   ],
152   "enforceLivenessKyc": true,
153   "kycMinAge": 1.1,
154   "parent": "string",
155   "customPayInFees": [
156     {
157       "fee": {
158         "cents": 1.1,
159         "currency": "USD",
160         "percent": null,
161         "isFixed": true
162       },
163       "lineItemLabel": "string"
164     }
165   ],
166   "minTransactionAmount": {
167     "cents": 1
168   },
169   "maxTransactionAmount": {
170     "cents": 1
171   },
172   "paypalMerchantId": "string",
173   "paypalClientId": "string",
174   "firstPartyPayoutOverrides": {
175     "interacPayoutProvider": "checkbook",
176     "wirePayoutProvider": [
177       "MOCK"
178     ],
179     "paypalPayoutProvider": "checkbook",
180     "venmoPayoutProvider": "checkbook",
181     "appleP2cPayoutProvider": "aptpay",
182     "globalP2cPayoutProvider": "aptpay",
183     "p2cPayoutProvider": "aptpay",
184     "eftPayoutProvider": "checkbook",
185     "pixPayoutProvider": "avenia",
186     "rtpPayoutProvider": "dwolla",
187     "ibanPayoutProvider": "merge",
188     "bankPayoutProvider": [
189       "aptpay"
190     ]
191   }
192 }

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

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

paypalRequireLoginboolean

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.

pushToCardEnabledbooleanDeprecated

brandobjectOptional

colorsobjectOptional

urlstringOptional

supportEmailstringOptional

settlementAddressesobjectOptional

bankPayoutProviderlist of enumsOptional

ibanPayoutProviderslist of enumsOptional

swiftPayoutProviderslist of enumsOptional

ibanPayoutProviderenumOptional

rtpPayoutProviderslist of enumsOptional

rtpPayoutProviderenumOptional

pixPayoutProviderslist of enumsOptional

pixPayoutProviderenumOptional

eftPayoutProviderslist of enumsOptional

eftPayoutProviderenumOptional

p2cPayoutProviderslist of enumsOptional

p2cPayoutProviderenumOptional

globalP2cPayoutProviderenumOptional

appleP2cPayoutProviderenumOptional

venmoPayoutProviderslist of enumsOptional

venmoPayoutProviderenumOptional

paypalPayoutProviderslist of enumsOptional

paypalPayoutProviderenumOptional

wirePayoutProviderlist of enumsOptional

cryptoPayoutProviderslist of enumsOptional

interacPayoutProviderslist of enumsOptional

interacPayoutProviderenumOptional

interacPaymentProviderenumOptional

enforceCheckoutJwtbooleanOptional

externalVerificationLinksbooleanOptional

whitelistedAncestorUrlslist of stringsOptional

enforceLivenessKycbooleanOptional

kycMinAgedoubleOptional

parentstringOptional

customPayInFeeslist of objectsOptional

minTransactionAmountobjectOptional

maxTransactionAmountobjectOptional

paypalMerchantIdstringOptional

paypalClientIdstringOptional

firstPartyPayoutOverridesobjectOptionalDeprecated

Errors

404

Not Found Error