Get Merchant

Deprecated

GET

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

GET

/api/merchant

1 curl https://api-sandbox.coinflow.cash/api/merchant \
2      -H "Authorization: <apiKey>"

200Retrieved

1 {
2   "_id": "string",
3   "merchantId": "string",
4   "verification": {
5     "reference": "string",
6     "status": "pending",
7     "vendor": "middesk",
8     "name": "string",
9     "attested": true,
10     "shareToken": "string",
11     "shareTokenStatus": "string",
12     "sessionToken": "string"
13   },
14   "withdrawFees": {
15     "business": {
16       "asap": {
17         "fixed": {
18           "cents": 1
19         },
20         "variableBps": 1.1,
21         "minimum": {
22           "cents": 1
23         },
24         "maximum": {
25           "cents": 1
26         },
27         "limit": {
28           "singleTxLimit": {
29             "cents": 1
30           },
31           "dailyLimit": {
32             "cents": 1
33           },
34           "monthlyLimit": {
35             "cents": 1
36           }
37         }
38       },
39       "same_day": {
40         "fixed": {
41           "cents": 1
42         },
43         "variableBps": 1.1,
44         "minimum": {
45           "cents": 1
46         },
47         "maximum": {
48           "cents": 1
49         },
50         "limit": {
51           "singleTxLimit": {
52             "cents": 1
53           },
54           "dailyLimit": {
55             "cents": 1
56           },
57           "monthlyLimit": {
58             "cents": 1
59           }
60         }
61       },
62       "standard": {
63         "fixed": {
64           "cents": 1
65         },
66         "variableBps": 1.1,
67         "minimum": {
68           "cents": 1
69         },
70         "maximum": {
71           "cents": 1
72         },
73         "limit": {
74           "singleTxLimit": {
75             "cents": 1
76           },
77           "dailyLimit": {
78             "cents": 1
79           },
80           "monthlyLimit": {
81             "cents": 1
82           }
83         }
84       },
85       "card": {
86         "fixed": {
87           "cents": 1
88         },
89         "variableBps": 1.1,
90         "minimum": {
91           "cents": 1
92         },
93         "maximum": {
94           "cents": 1
95         },
96         "limit": {
97           "singleTxLimit": {
98             "cents": 1
99           },
100           "dailyLimit": {
101             "cents": 1
102           },
103           "monthlyLimit": {
104             "cents": 1
105           }
106         }
107       },
108       "iban": {
109         "fixed": {
110           "cents": 1
111         },
112         "variableBps": 1.1,
113         "minimum": {
114           "cents": 1
115         },
116         "maximum": {
117           "cents": 1
118         },
119         "limit": {
120           "singleTxLimit": {
121             "cents": 1
122           },
123           "dailyLimit": {
124             "cents": 1
125           },
126           "monthlyLimit": {
127             "cents": 1
128           }
129         }
130       },
131       "pix": {
132         "fixed": {
133           "cents": 1
134         },
135         "variableBps": 1.1,
136         "minimum": {
137           "cents": 1
138         },
139         "maximum": {
140           "cents": 1
141         },
142         "limit": {
143           "singleTxLimit": {
144             "cents": 1
145           },
146           "dailyLimit": {
147             "cents": 1
148           },
149           "monthlyLimit": {
150             "cents": 1
151           }
152         }
153       },
154       "eft": {
155         "fixed": {
156           "cents": 1
157         },
158         "variableBps": 1.1,
159         "minimum": {
160           "cents": 1
161         },
162         "maximum": {
163           "cents": 1
164         },
165         "limit": {
166           "singleTxLimit": {
167             "cents": 1
168           },
169           "dailyLimit": {
170             "cents": 1
171           },
172           "monthlyLimit": {
173             "cents": 1
174           }
175         }
176       },
177       "venmo": {
178         "fixed": {
179           "cents": 1
180         },
181         "variableBps": 1.1,
182         "minimum": {
183           "cents": 1
184         },
185         "maximum": {
186           "cents": 1
187         },
188         "limit": {
189           "singleTxLimit": {
190             "cents": 1
191           },
192           "dailyLimit": {
193             "cents": 1
194           },
195           "monthlyLimit": {
196             "cents": 1
197           }
198         }
199       },
200       "paypal": {
201         "fixed": {
202           "cents": 1
203         },
204         "variableBps": 1.1,
205         "minimum": {
206           "cents": 1
207         },
208         "maximum": {
209           "cents": 1
210         },
211         "limit": {
212           "singleTxLimit": {
213             "cents": 1
214           },
215           "dailyLimit": {
216             "cents": 1
217           },
218           "monthlyLimit": {
219             "cents": 1
220           }
221         }
222       },
223       "wire": {
224         "fixed": {
225           "cents": 1
226         },
227         "variableBps": 1.1,
228         "minimum": {
229           "cents": 1
230         },
231         "maximum": {
232           "cents": 1
233         },
234         "limit": {
235           "singleTxLimit": {
236             "cents": 1
237           },
238           "dailyLimit": {
239             "cents": 1
240           },
241           "monthlyLimit": {
242             "cents": 1
243           }
244         }
245       },
246       "interac": {
247         "fixed": {
248           "cents": 1
249         },
250         "variableBps": 1.1,
251         "minimum": {
252           "cents": 1
253         },
254         "maximum": {
255           "cents": 1
256         },
257         "limit": {
258           "singleTxLimit": {
259             "cents": 1
260           },
261           "dailyLimit": {
262             "cents": 1
263           },
264           "monthlyLimit": {
265             "cents": 1
266           }
267         }
268       }
269     },
270     "user": {
271       "asap": {
272         "fixed": {
273           "cents": 1
274         },
275         "variableBps": 1.1,
276         "minimum": {
277           "cents": 1
278         },
279         "maximum": {
280           "cents": 1
281         },
282         "limit": {
283           "singleTxLimit": {
284             "cents": 1
285           },
286           "dailyLimit": {
287             "cents": 1
288           },
289           "monthlyLimit": {
290             "cents": 1
291           }
292         }
293       },
294       "same_day": {
295         "fixed": {
296           "cents": 1
297         },
298         "variableBps": 1.1,
299         "minimum": {
300           "cents": 1
301         },
302         "maximum": {
303           "cents": 1
304         },
305         "limit": {
306           "singleTxLimit": {
307             "cents": 1
308           },
309           "dailyLimit": {
310             "cents": 1
311           },
312           "monthlyLimit": {
313             "cents": 1
314           }
315         }
316       },
317       "standard": {
318         "fixed": {
319           "cents": 1
320         },
321         "variableBps": 1.1,
322         "minimum": {
323           "cents": 1
324         },
325         "maximum": {
326           "cents": 1
327         },
328         "limit": {
329           "singleTxLimit": {
330             "cents": 1
331           },
332           "dailyLimit": {
333             "cents": 1
334           },
335           "monthlyLimit": {
336             "cents": 1
337           }
338         }
339       },
340       "card": {
341         "fixed": {
342           "cents": 1
343         },
344         "variableBps": 1.1,
345         "minimum": {
346           "cents": 1
347         },
348         "maximum": {
349           "cents": 1
350         },
351         "limit": {
352           "singleTxLimit": {
353             "cents": 1
354           },
355           "dailyLimit": {
356             "cents": 1
357           },
358           "monthlyLimit": {
359             "cents": 1
360           }
361         }
362       },
363       "iban": {
364         "fixed": {
365           "cents": 1
366         },
367         "variableBps": 1.1,
368         "minimum": {
369           "cents": 1
370         },
371         "maximum": {
372           "cents": 1
373         },
374         "limit": {
375           "singleTxLimit": {
376             "cents": 1
377           },
378           "dailyLimit": {
379             "cents": 1
380           },
381           "monthlyLimit": {
382             "cents": 1
383           }
384         }
385       },
386       "pix": {
387         "fixed": {
388           "cents": 1
389         },
390         "variableBps": 1.1,
391         "minimum": {
392           "cents": 1
393         },
394         "maximum": {
395           "cents": 1
396         },
397         "limit": {
398           "singleTxLimit": {
399             "cents": 1
400           },
401           "dailyLimit": {
402             "cents": 1
403           },
404           "monthlyLimit": {
405             "cents": 1
406           }
407         }
408       },
409       "eft": {
410         "fixed": {
411           "cents": 1
412         },
413         "variableBps": 1.1,
414         "minimum": {
415           "cents": 1
416         },
417         "maximum": {
418           "cents": 1
419         },
420         "limit": {
421           "singleTxLimit": {
422             "cents": 1
423           },
424           "dailyLimit": {
425             "cents": 1
426           },
427           "monthlyLimit": {
428             "cents": 1
429           }
430         }
431       },
432       "venmo": {
433         "fixed": {
434           "cents": 1
435         },
436         "variableBps": 1.1,
437         "minimum": {
438           "cents": 1
439         },
440         "maximum": {
441           "cents": 1
442         },
443         "limit": {
444           "singleTxLimit": {
445             "cents": 1
446           },
447           "dailyLimit": {
448             "cents": 1
449           },
450           "monthlyLimit": {
451             "cents": 1
452           }
453         }
454       },
455       "paypal": {
456         "fixed": {
457           "cents": 1
458         },
459         "variableBps": 1.1,
460         "minimum": {
461           "cents": 1
462         },
463         "maximum": {
464           "cents": 1
465         },
466         "limit": {
467           "singleTxLimit": {
468             "cents": 1
469           },
470           "dailyLimit": {
471             "cents": 1
472           },
473           "monthlyLimit": {
474             "cents": 1
475           }
476         }
477       },
478       "wire": {
479         "fixed": {
480           "cents": 1
481         },
482         "variableBps": 1.1,
483         "minimum": {
484           "cents": 1
485         },
486         "maximum": {
487           "cents": 1
488         },
489         "limit": {
490           "singleTxLimit": {
491             "cents": 1
492           },
493           "dailyLimit": {
494             "cents": 1
495           },
496           "monthlyLimit": {
497             "cents": 1
498           }
499         }
500       },
501       "interac": {
502         "fixed": {
503           "cents": 1
504         },
505         "variableBps": 1.1,
506         "minimum": {
507           "cents": 1
508         },
509         "maximum": {
510           "cents": 1
511         },
512         "limit": {
513           "singleTxLimit": {
514             "cents": 1
515           },
516           "dailyLimit": {
517             "cents": 1
518           },
519           "monthlyLimit": {
520             "cents": 1
521           }
522         }
523       }
524     },
525     "swapBps": 1.1
526   },
527   "wallets": {
528     "stellar": {
529       "usdcPayer": "string"
530     },
531     "evm": {
532       "usdcPayer": "string",
533       "feePayer": "string"
534     },
535     "solana": {
536       "usdcPayer": "string",
537       "feePayer": "string"
538     }
539   },
540   "apiKey": "string",
541   "apiKeys": [
542     {
543       "privateUuid": "string",
544       "publicUuid": "string",
545       "disabled": true
546     }
547   ],
548   "kycType": "person",
549   "settlementToken": "USDC",
550   "users": [
551     {
552       "email": "string",
553       "scope": "admin",
554       "password": "string",
555       "secret": "string",
556       "resetNonce": "string",
557       "resetNonceUsed": true,
558       "ssoProvider": "google",
559       "ssoId": "string"
560     }
561   ],
562   "ubos": [
563     {
564       "reference": "string",
565       "status": "pending",
566       "vendor": "middesk",
567       "name": "string",
568       "attested": true,
569       "shareToken": "string",
570       "shareTokenStatus": "string",
571       "sessionToken": "string"
572     }
573   ],
574   "goLiveChecklist": {
575     "acceptedToS": true,
576     "programWhitelistRequests": [
577       {
578         "programId": "string",
579         "blockchain": "solana",
580         "status": "approved"
581       }
582     ],
583     "rfis": [
584       {
585         "status": "pending",
586         "url": "string",
587         "name": "string"
588       }
589     ],
590     "onboardingFormSubmitted": true,
591     "applicationSubmitted": true,
592     "applicationSubmittedAt": "2024-01-15T09:30:00Z",
593     "lockIndustry": true
594   },
595   "cardSettings": {
596     "paysFees": true,
597     "paysChargebackProtectionFees": true,
598     "paysGasFees": true,
599     "paysFxFees": true,
600     "paysNetworkFees": true,
601     "customerEmailNotifications": true,
602     "merchantEmailNotifications": true,
603     "avsCheck": true,
604     "threeDsChallengePreference": "NoPreference",
605     "enforce3DSWhenProtectionExempt": true,
606     "processor": "payarc",
607     "orchestrationRuleId": "string",
608     "applePayProcessor": "payarc",
609     "googlePayProcessor": "payarc",
610     "fixedFee": {
611       "cents": 1
612     },
613     "variableFeeBps": 1.1,
614     "networkFeeBps": 1.1,
615     "supportsGooglePay": true,
616     "supportsApplePay": true,
617     "saveCardDefault": true,
618     "ignoreProcessorLimit": true,
619     "nameMatchThreshold": 1.1,
620     "verificationSettings": {
621       "threshold3DS": {
622         "cents": 1
623       },
624       "verificationLimit": {
625         "cents": 1
626       }
627     },
628     "shift4MerchantArgs": {
629       "url": "string",
630       "merchantId": "string",
631       "secretKey": "string",
632       "noFraudFallback": true
633     },
634     "eMerchantPayMerchantArgs": {
635       "AUD": {
636         "cvv": "string",
637         "threeD": "string"
638       },
639       "CAD": {
640         "cvv": "string",
641         "threeD": "string"
642       },
643       "EUR": {
644         "cvv": "string",
645         "threeD": "string"
646       },
647       "GBP": {
648         "cvv": "string",
649         "threeD": "string"
650       },
651       "JPY": {
652         "cvv": "string",
653         "threeD": "string"
654       },
655       "NZD": {
656         "cvv": "string",
657         "threeD": "string"
658       },
659       "USD": {
660         "cvv": "string",
661         "threeD": "string"
662       }
663     },
664     "greenlightMerchantArgs": {
665       "securityKey": "string",
666       "mid": "string"
667     },
668     "nuveiV1MerchantArgs": {
669       "merchantId": "string",
670       "merchantSiteId": "string",
671       "conversionAffiliateCountryCode": "string"
672     },
673     "natWestMerchantArgs": {
674       "entityId": "string",
675       "mcc": "string"
676     },
677     "mvbMerchantArgs": {
678       "entityId": "string",
679       "mcc": "string"
680     },
681     "fifthThirdMerchantArgs": {
682       "entityId": "string",
683       "mcc": "string"
684     },
685     "threeDSArgs": {
686       "AMEX": {
687         "merchantId": "string",
688         "bin": "string",
689         "name": "string",
690         "mcc": "string"
691       },
692       "DISC": {
693         "merchantId": "string",
694         "bin": "string",
695         "name": "string",
696         "mcc": "string"
697       },
698       "MSTR": {
699         "merchantId": "string",
700         "bin": "string",
701         "name": "string",
702         "mcc": "string"
703       },
704       "VISA": {
705         "merchantId": "string",
706         "bin": "string",
707         "name": "string",
708         "mcc": "string"
709       },
710       "allowAttempts": true,
711       "mcc": "string",
712       "scaOnly": true
713     },
714     "statementDescriptor": "string",
715     "tokenizationProvider": "bt",
716     "presettleCardOnDirectPurchase": true,
717     "applePayIntegratorRegistration": {
718       "domainNames": [
719         "string"
720       ],
721       "partnerMerchantName": "string",
722       "partnerMerchantValidationURI": "string",
723       "partnerInternalMerchantIdentifier": "string"
724     },
725     "applePayMerchantDecryption": true,
726     "applePayCertificates": {
727       "merchantIdCert": "string",
728       "privatePem": "string",
729       "certPem": "string",
730       "merchantDisplay": "string",
731       "merchantIdentifier": "string"
732     },
733     "aftSettings": {
734       "enabled": true,
735       "type": "disbursement",
736       "purpose": "businessToBusiness",
737       "merchantA2AMastercardAftRecipient": {
738         "walletReference": "string",
739         "countryCode": "string",
740         "state": "string",
741         "postalCode": "string",
742         "city": "string",
743         "address1": "string",
744         "lastName": "string",
745         "firstName": "string"
746       }
747     },
748     "customStatementDescriptor": true,
749     "cardOnFileSettings": {
750       "enabled": true,
751       "period": 1.1,
752       "maxCount": 1.1,
753       "maxMultiple": 1.1,
754       "expiration": 1.1,
755       "maxZeroAuthAmount": {
756         "cents": 1
757       },
758       "maxAmountLookback": 1.1
759     },
760     "mitSettings": {
761       "enabled": true,
762       "period": 1.1,
763       "maxCount": 1.1,
764       "maxMultiple": 1.1,
765       "expiration": 1.1,
766       "maxZeroAuthAmount": {
767         "cents": 1
768       },
769       "maxAmountLookback": 1.1
770     },
771     "blockCardReuseAcrossCustomers": true
772   },
773   "achSettings": {
774     "paysFees": true,
775     "allowDelayedTransactions": true,
776     "customerEmailNotifications": true,
777     "merchantEmailNotifications": true,
778     "instantSettle": true,
779     "processor": "mock",
780     "maxAmount": {
781       "cents": 1
782     },
783     "nameMatchThreshold": 1.1,
784     "minFee": {
785       "cents": 1
786     },
787     "maxFee": {
788       "cents": 1
789     },
790     "feeBps": 1.1,
791     "fixedFee": {
792       "cents": 1
793     },
794     "settlementDays": 1.1
795   },
796   "wireSettings": {
797     "paysFees": true,
798     "paysFxFees": true,
799     "customerEmailNotifications": true,
800     "merchantEmailNotifications": true,
801     "processor": "braid",
802     "minFee": {
803       "cents": 1
804     },
805     "maxFee": {
806       "cents": 1
807     },
808     "feeBps": 1.1,
809     "fixedFee": {
810       "cents": 1
811     },
812     "dailyLimit": {
813       "cents": 1
814     }
815   },
816   "pixSettings": {
817     "paysFees": true,
818     "paysFxFees": true,
819     "customerEmailNotifications": true,
820     "merchantEmailNotifications": true,
821     "processor": "brla",
822     "fixedFee": {
823       "cents": 1
824     },
825     "feeBps": 1.1
826   },
827   "ibanSettings": {
828     "paysFees": true,
829     "paysFxFees": true,
830     "customerEmailNotifications": true,
831     "merchantEmailNotifications": true,
832     "processor": "merge",
833     "fixedFee": {
834       "cents": 1
835     },
836     "feeBps": 1.1,
837     "minFee": {
838       "cents": 1
839     }
840   },
841   "cryptoPayinSettings": {
842     "stables": {
843       "feeBps": 1.1,
844       "paysFees": true,
845       "enabled": true
846     },
847     "majors": {
848       "feeBps": 1.1,
849       "paysFees": true,
850       "enabled": true
851     },
852     "volatile": {
853       "feeBps": 1.1,
854       "paysFees": true,
855       "enabled": true
856     },
857     "enabled": true,
858     "maxGasFeePayment": {
859       "cents": 1
860     },
861     "coinbaseDisabled": true,
862     "customerEmailNotifications": true,
863     "merchantEmailNotifications": true,
864     "transferOnly": true,
865     "fixedFee": {
866       "cents": 1
867     },
868     "paysFee": true,
869     "enableStableDepositAddresses": true
870   },
871   "cashAppSettings": {
872     "paysFees": true,
873     "paysFxFees": true,
874     "customerEmailNotifications": true,
875     "merchantEmailNotifications": true,
876     "processor": "mock",
877     "fixedFee": {
878       "cents": 1
879     },
880     "feeBps": 1.1,
881     "minFee": {
882       "cents": 1
883     }
884   },
885   "nSureSettings": {
886     "nSureInsurance": true,
887     "nSureAchInsurance": true,
888     "nSureFixedFee": {
889       "cents": 1
890     },
891     "nSureVariableFeeBps": 1.1,
892     "disableOverrides": true,
893     "nSurePartnerId": "string",
894     "segmentId": "string",
895     "protectionMinimum": {
896       "cents": 1
897     },
898     "ignoreRejection": true,
899     "doNotReview": true,
900     "enableOverrideReview": true,
901     "overrideReviewHours": 1.1,
902     "unprotectedDailyMaximum": {
903       "cents": 1
904     },
905     "unprotectedMonthlyMaximum": {
906       "cents": 1
907     },
908     "accountType": "guest"
909   },
910   "hideBranding": true,
911   "onlyShowTotal": true,
912   "skipSendWithdrawEmail": true,
913   "sendInvoiceNotifications": true,
914   "requireAniCheck": true,
915   "refundBalanceLimit": {
916     "cents": 1
917   },
918   "creditSeed": "string",
919   "withdrawSettlementLocation": "circle",
920   "enforceJwt": true,
921   "delayedSettlementDays": 1.1,
922   "interchangeFees": {
923     "settings": {
924       "useType": true,
925       "useRegion": true,
926       "useScheme": true,
927       "useBrand": true,
928       "useDurbin": true
929     },
930     "rates": {}
931   },
932   "pushToCardEnabled": true,
933   "brand": {
934     "portalBrand": "approvely",
935     "logo": "string",
936     "displayName": "string"
937   },
938   "colors": {
939     "style": "rounded",
940     "font": "string",
941     "ctaColor": "string",
942     "textColorAction": "string",
943     "textColorAccent": "string",
944     "textColor": "string",
945     "backgroundAccent2": "string",
946     "backgroundAccent": "string",
947     "background": "string",
948     "primary": "string"
949   },
950   "url": "string",
951   "customWithdrawFees": {
952     "global": {
953       "coverProcessingFees": true,
954       "cents": 1.1,
955       "currency": "USD",
956       "isFixed": true
957     },
958     "isBundled": true,
959     "lineItemLabel": "string",
960     "asap": {
961       "coverProcessingFees": true,
962       "cents": 1.1,
963       "currency": "USD",
964       "isFixed": true
965     },
966     "card": {
967       "coverProcessingFees": true,
968       "cents": 1.1,
969       "currency": "USD",
970       "isFixed": true
971     },
972     "eft": {
973       "coverProcessingFees": true,
974       "cents": 1.1,
975       "currency": "USD",
976       "isFixed": true
977     },
978     "iban": {
979       "coverProcessingFees": true,
980       "cents": 1.1,
981       "currency": "USD",
982       "isFixed": true
983     },
984     "interac": {
985       "coverProcessingFees": true,
986       "cents": 1.1,
987       "currency": "USD",
988       "isFixed": true
989     },
990     "paypal": {
991       "coverProcessingFees": true,
992       "cents": 1.1,
993       "currency": "USD",
994       "isFixed": true
995     },
996     "pix": {
997       "coverProcessingFees": true,
998       "cents": 1.1,
999       "currency": "USD",
1000       "isFixed": true
1001     },
1002     "same_day": {
1003       "coverProcessingFees": true,
1004       "cents": 1.1,
1005       "currency": "USD",
1006       "isFixed": true
1007     },
1008     "standard": {
1009       "coverProcessingFees": true,
1010       "cents": 1.1,
1011       "currency": "USD",
1012       "isFixed": true
1013     },
1014     "venmo": {
1015       "coverProcessingFees": true,
1016       "cents": 1.1,
1017       "currency": "USD",
1018       "isFixed": true
1019     },
1020     "wire": {
1021       "coverProcessingFees": true,
1022       "cents": 1.1,
1023       "currency": "USD",
1024       "isFixed": true
1025     }
1026   },
1027   "customPayInFees": [
1028     {
1029       "fee": {
1030         "cents": 1.1,
1031         "currency": "USD",
1032         "isFixed": true
1033       },
1034       "lineItemLabel": "string"
1035     }
1036   ],
1037   "webhookValidationKey": "string",
1038   "settlementAddresses": {
1039     "solana": "string",
1040     "eth": "string",
1041     "polygon": "string",
1042     "base": "string",
1043     "user": "string",
1044     "xion": "string",
1045     "arbitrum": "string",
1046     "stellar": "string",
1047     "monad": "string",
1048     "tempo": "string",
1049     "mpcWalletProvider": "metakeep",
1050     "recipientAddresses": [
1051       {
1052         "createdAt": "2024-01-15T09:30:00Z",
1053         "recipient": "string",
1054         "info": {}
1055       }
1056     ],
1057     "verification": {
1058       "reference": "string",
1059       "status": "pending",
1060       "vendor": "middesk",
1061       "name": "string",
1062       "attested": true,
1063       "shareToken": "string",
1064       "shareTokenStatus": "string",
1065       "sessionToken": "string"
1066     }
1067   },
1068   "webhookSettings": {
1069     "webhookUrls": [
1070       "string"
1071     ],
1072     "version": "Legacy",
1073     "subscriptions": [
1074       "Card Payment Authorized"
1075     ],
1076     "disableAuthorizationHeader": true
1077   },
1078   "citconSettings": {
1079     "fundPurpose": "goods",
1080     "apiKey": "string"
1081   },
1082   "aptPayCanadaSettings": {
1083     "id": "string"
1084   },
1085   "verisoulSettings": {
1086     "enabled": true,
1087     "riskThresholds": {
1088       "device_risk": 1.1,
1089       "proxy": 1.1,
1090       "vpn": 1.1,
1091       "tor": 1.1,
1092       "spoofed_ip": 1.1,
1093       "datacenter": 1.1,
1094       "recent_fraud_ip": 1.1,
1095       "impossible_travel": 1.1,
1096       "device_network_mismatch": 1.1,
1097       "account_score": 1.1,
1098       "risk_signals": 1.1,
1099       "email_score": 1.1
1100     }
1101   },
1102   "blockConfig": {
1103     "disableDestinationAuthKey": true,
1104     "enableNmiSettlement": true,
1105     "disableInvoiceWalletPayment": true,
1106     "bannedWithdrawalStates": [
1107       "AL"
1108     ],
1109     "whitelistedBinLocations": [
1110       "AF"
1111     ],
1112     "failedPaymentAttemptLimit": 1.1
1113   },
1114   "billingEmails": [
1115     "string"
1116   ],
1117   "withdrawFeePayment": {
1118     "paysGasFees": {
1119       "stellar": true,
1120       "xion": true,
1121       "user": true,
1122       "flow": true,
1123       "tempo": true,
1124       "monad": true,
1125       "arbitrum": true,
1126       "base": true,
1127       "eth": true,
1128       "polygon": true,
1129       "solana": true
1130     },
1131     "paysSwapFees": true,
1132     "paysWithdrawFees": true
1133   },
1134   "bankPayoutProvider": [
1135     "aptpay"
1136   ],
1137   "ibanPayoutProvider": "merge",
1138   "rtpPayoutProvider": "dwolla",
1139   "pixPayoutProvider": "brla",
1140   "eftPayoutProvider": "cybrid",
1141   "p2cPayoutProvider": "aptpay",
1142   "globalP2cPayoutProvider": "aptpay",
1143   "appleP2cPayoutProvider": "aptpay",
1144   "venmoPayoutProvider": "checkbook",
1145   "paypalPayoutProvider": "checkbook",
1146   "wirePayoutProvider": [
1147     "MOCK"
1148   ],
1149   "interacPayoutProvider": "checkbook",
1150   "maxTransactionAmount": {
1151     "cents": 1
1152   },
1153   "parent": "string",
1154   "enforceCheckoutJwt": true,
1155   "metakeepAppId": "string",
1156   "externalVerificationLinks": true,
1157   "whitelistedAncestorUrls": [
1158     "string"
1159   ],
1160   "banDuplicateAccounts": true,
1161   "ignoreCustomer10kDailyLimit": true,
1162   "fxFees": {
1163     "USD": 1.1,
1164     "AED": 1.1,
1165     "AFN": 1.1,
1166     "ALL": 1.1,
1167     "AMD": 1.1,
1168     "ANG": 1.1,
1169     "AOA": 1.1,
1170     "ARS": 1.1,
1171     "AUD": 1.1,
1172     "AWG": 1.1,
1173     "AZN": 1.1,
1174     "BAM": 1.1,
1175     "BBD": 1.1,
1176     "BDT": 1.1,
1177     "BGN": 1.1,
1178     "BHD": 1.1,
1179     "BIF": 1.1,
1180     "BMD": 1.1,
1181     "BND": 1.1,
1182     "BOB": 1.1,
1183     "BRL": 1.1,
1184     "BSD": 1.1,
1185     "BTN": 1.1,
1186     "BWP": 1.1,
1187     "BYN": 1.1,
1188     "BZD": 1.1,
1189     "CAD": 1.1,
1190     "CHF": 1.1,
1191     "CLF": 1.1,
1192     "CLP": 1.1,
1193     "CNY": 1.1,
1194     "COP": 1.1,
1195     "CRC": 1.1,
1196     "CUP": 1.1,
1197     "CVE": 1.1,
1198     "CZK": 1.1,
1199     "DJF": 1.1,
1200     "DKK": 1.1,
1201     "DOP": 1.1,
1202     "DZD": 1.1,
1203     "EGP": 1.1,
1204     "ETB": 1.1,
1205     "EUR": 1.1,
1206     "FJD": 1.1,
1207     "GBP": 1.1,
1208     "GEL": 1.1,
1209     "GHS": 1.1,
1210     "GMD": 1.1,
1211     "GNF": 1.1,
1212     "GTQ": 1.1,
1213     "GYD": 1.1,
1214     "HKD": 1.1,
1215     "HNL": 1.1,
1216     "HTG": 1.1,
1217     "HUF": 1.1,
1218     "IDR": 1.1,
1219     "ILS": 1.1,
1220     "INR": 1.1,
1221     "IQD": 1.1,
1222     "IRR": 1.1,
1223     "ISK": 1.1,
1224     "JMD": 1.1,
1225     "JOD": 1.1,
1226     "JPY": 1.1,
1227     "KES": 1.1,
1228     "KGS": 1.1,
1229     "KHR": 1.1,
1230     "KMF": 1.1,
1231     "KRW": 1.1,
1232     "KWD": 1.1,
1233     "KYD": 1.1,
1234     "KZT": 1.1,
1235     "LAK": 1.1,
1236     "LBP": 1.1,
1237     "LKR": 1.1,
1238     "LRD": 1.1,
1239     "LSL": 1.1,
1240     "LYD": 1.1,
1241     "MAD": 1.1,
1242     "MDL": 1.1,
1243     "MGA": 1.1,
1244     "MKD": 1.1,
1245     "MMK": 1.1,
1246     "MNT": 1.1,
1247     "MOP": 1.1,
1248     "MRU": 1.1,
1249     "MUR": 1.1,
1250     "MWK": 1.1,
1251     "MVR": 1.1,
1252     "MXN": 1.1,
1253     "MYR": 1.1,
1254     "MZN": 1.1,
1255     "NAD": 1.1,
1256     "NGN": 1.1,
1257     "NIO": 1.1,
1258     "NOK": 1.1,
1259     "NPR": 1.1,
1260     "NZD": 1.1,
1261     "OMR": 1.1,
1262     "PAB": 1.1,
1263     "PEN": 1.1,
1264     "PGK": 1.1,
1265     "PHP": 1.1,
1266     "PKR": 1.1,
1267     "PLN": 1.1,
1268     "PYG": 1.1,
1269     "QAR": 1.1,
1270     "RON": 1.1,
1271     "RSD": 1.1,
1272     "RWF": 1.1,
1273     "SAR": 1.1,
1274     "SCR": 1.1,
1275     "SDG": 1.1,
1276     "SEK": 1.1,
1277     "SGD": 1.1,
1278     "SLE": 1.1,
1279     "SLL": 1.1,
1280     "SOS": 1.1,
1281     "SRD": 1.1,
1282     "STN": 1.1,
1283     "SVC": 1.1,
1284     "SYP": 1.1,
1285     "SZL": 1.1,
1286     "THB": 1.1,
1287     "TJS": 1.1,
1288     "TMT": 1.1,
1289     "TND": 1.1,
1290     "TOP": 1.1,
1291     "TRY": 1.1,
1292     "TTD": 1.1,
1293     "TWD": 1.1,
1294     "TZS": 1.1,
1295     "UAH": 1.1,
1296     "UGX": 1.1,
1297     "UYU": 1.1,
1298     "UZS": 1.1,
1299     "VND": 1.1,
1300     "VUV": 1.1,
1301     "WST": 1.1,
1302     "XAF": 1.1,
1303     "XCD": 1.1,
1304     "XOF": 1.1,
1305     "XPF": 1.1,
1306     "YER": 1.1,
1307     "ZAR": 1.1,
1308     "ZMW": 1.1,
1309     "ZWL": 1.1,
1310     "CDF": 1.1,
1311     "ERN": 1.1,
1312     "FKP": 1.1,
1313     "KPW": 1.1,
1314     "RUB": 1.1,
1315     "SBD": 1.1,
1316     "SHP": 1.1,
1317     "SSP": 1.1,
1318     "VES": 1.1
1319   },
1320   "blocked": {
1321     "level": "Unverified",
1322     "reason": "string",
1323     "editor": "string",
1324     "blockedAt": "2024-01-15T09:30:00Z",
1325     "recoverySignature": "string"
1326   },
1327   "vendorSettings": {
1328     "aptPayIdentity": 1.1,
1329     "braid": {
1330       "businessId": 1.1,
1331       "accountId": 1.1,
1332       "accountNumber": "string",
1333       "reserveAccountId": 1.1,
1334       "reserveAccountNumber": "string",
1335       "rollingAccountId": 1.1,
1336       "rollingAccountNumber": "string"
1337     }
1338   },
1339   "generatedDescription": "string",
1340   "bankSettlementOptions": {
1341     "token": "string",
1342     "minRemainingBalance": {
1343       "cents": 1
1344     }
1345   },
1346   "allowAttestedKyc": true,
1347   "attestedKycSsnNotRequired": true,
1348   "allowAccountSharing": true,
1349   "personaKycShareTokenTemplate": "string",
1350   "velocitySettings": {
1351     "limitMode": "default",
1352     "customLimit": 1.1,
1353     "haltOnThreshold": true,
1354     "lastHaltNotificationSentAt": "2024-01-15T09:30:00Z"
1355   },
1356   "enforceLivenessKyc": true,
1357   "canCreateBankAccounts": true,
1358   "checkbookSettings": {
1359     "merchantName": "string",
1360     "secret": "string",
1361     "key": "string",
1362     "walletId": "string",
1363     "id": "string"
1364   },
1365   "reserveSettings": {
1366     "status": "Disabled",
1367     "rollingBps": 1.1,
1368     "rollingDuration": 1.1,
1369     "notes": "string"
1370   },
1371   "globalRateLimit": 1.1,
1372   "banProxiesForCheckoutEndpoints": true,
1373   "riskControls": {
1374     "topup": {
1375       "minAmountCents": 1.1,
1376       "maxAmountCents": 1.1
1377     }
1378   },
1379   "acceptedToS": true,
1380   "ssoSettings": {
1381     "requireSso": true
1382   },
1383   "chargebackFeeCents": 1.1
1384 }

Get the merchant

Authentication

Authorizationstring

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

Response

_idstring

merchantIdstring

verificationobject

withdrawFeesobject

walletsobject

apiKeystring

apiKeyslist of objects

kycTypeenum

Allowed values:

settlementTokenenum or string

userslist of objects

uboslist of objects

goLiveChecklistobject

cardSettingsobject

achSettingsobject

wireSettingsobject

pixSettingsobject

ibanSettingsobject

cryptoPayinSettingsobject

cashAppSettingsobject

nSureSettingsobject

hideBrandingboolean

onlyShowTotalboolean

skipSendWithdrawEmailboolean

sendInvoiceNotificationsboolean

requireAniCheckboolean

refundBalanceLimitobject

creditSeedstring

withdrawSettlementLocationenum

Allowed values:

enforceJwtboolean

delayedSettlementDaysdouble

Number of business days to delay stablecoin settlement after payment capture. Only applies to USDC settlements. 0 means no delay (immediate settlement). Maximum value is 5 days.

interchangeFeesobject

pushToCardEnabledbooleanDeprecated

brandobject

colorsobject

urlstring

customWithdrawFeesobject

customPayInFeeslist of objects

webhookValidationKeystring

settlementAddressesobject

webhookSettingsobject

citconSettingsobject

aptPayCanadaSettingsobject

verisoulSettingsobject

blockConfigobject

billingEmailslist of strings

withdrawFeePaymentobject

bankPayoutProviderlist of enums

ibanPayoutProviderenum

Allowed values:

rtpPayoutProviderenum

pixPayoutProviderenum

Allowed values:

eftPayoutProviderenum

Allowed values:

p2cPayoutProviderenum

Allowed values:

globalP2cPayoutProviderenum

Allowed values:

appleP2cPayoutProviderenum

Allowed values:

venmoPayoutProviderenum

Allowed values:

paypalPayoutProviderenum

Allowed values:

wirePayoutProviderlist of enums

Allowed values:

interacPayoutProviderenum

Allowed values:

maxTransactionAmountobject

parentstring

enforceCheckoutJwtboolean

metakeepAppIdstring

externalVerificationLinksboolean

whitelistedAncestorUrlslist of strings

banDuplicateAccountsboolean

ignoreCustomer10kDailyLimitboolean

Used to bypass the daily 10k limit per customer. This is specifically set for coinflow-invoice to true and shouldn’t be true for any other merchant. Not surfaced in settings

fxFeesobject

Make all properties in T optional

blockedobject

vendorSettingsobject

generatedDescriptionstring

bankSettlementOptionsobject

allowAttestedKycboolean

attestedKycSsnNotRequiredboolean

allowAccountSharingboolean

personaKycShareTokenTemplatestring

velocitySettingsobject

enforceLivenessKycboolean

canCreateBankAccountsboolean

checkbookSettingsobject

reserveSettingsobject

globalRateLimitdouble

banProxiesForCheckoutEndpointsboolean

riskControlsobject

acceptedToSboolean

ssoSettingsobject

chargebackFeeCentsdouble