Gets merchant withdrawers

GET

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

GET

/api/merchant/withdrawers

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

200Retrieved

1 [
2   {
3     "_id": "string",
4     "wallet": "string",
5     "blockchain": "solana",
6     "email": "string",
7     "availability": {
8       "status": "Functional",
9       "reason": "string",
10       "editor": "string",
11       "updatedAt": "2024-01-15T09:30:00Z"
12     },
13     "currency": "USD",
14     "merchant": "string",
15     "verification": {
16       "reference": "string",
17       "status": "pending",
18       "vendor": "middesk",
19       "name": "string",
20       "attested": true,
21       "shareToken": "string",
22       "shareTokenStatus": "string",
23       "sessionToken": "string",
24       "rejectionReasons": [
25         "string"
26       ]
27     },
28     "riskScoreOverride": true,
29     "country": "string",
30     "originalCurrency": "USD",
31     "geoBlockOverride": {
32       "reason": "string",
33       "setBy": "string",
34       "setAt": "2024-01-15T09:30:00Z",
35       "expiresAt": "2024-01-15T09:30:00Z"
36     },
37     "blockCardReuseExempt": true,
38     "createdAt": "2024-01-15T09:30:00Z",
39     "wallets": [
40       {
41         "wallet": "string",
42         "blockchain": "solana"
43       }
44     ]
45   }
46 ]

Authentication

Authorizationstring

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

Authorizationstring

API Key authentication via header

Query parameters

blockedstringOptional

Filter on blocked status (boolean string - ‘true’ or ‘false’)

searchstringOptional

Search term to filter results

Response

_idstring

walletstring

blockchainenum

emailstring

availabilityobject

currencyenum

merchantstring or object

verificationobject

riskScoreOverrideboolean

countrystring

originalCurrencyenumOptional

geoBlockOverrideobjectOptional

Per-customer exemption from real-time geographic enforcement.

When set and not expired, withdrawal blocking rules with method GEOLOCATION or IP are skipped for this withdrawer. KYC_ADDRESS rules still apply — KYC is the compliance floor and must remain enforceable.

Auditable by construction: reason and setBy are required so admins can review why a specific user was exempted. expiresAt is optional but strongly recommended; long-lived overrides should be avoided.

blockCardReuseExemptbooleanOptional

When true, this withdrawer is exempt from the merchant banDuplicateAccounts re-use check, so it may add an account that another withdrawer already uses without being blocked (423 PAYMENT_METHOD_IN_USE).

createdAtdatetimeOptional

walletslist of objectsOptionalDeprecated