Get Withdraws

GET

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

GET

/api/merchant/withdraws

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

200Retrieved

1 [
2   {
3     "createdAt": "2024-01-15T09:30:00Z",
4     "amount": {
5       "cents": 1,
6       "currency": "USD"
7     },
8     "speed": "asap",
9     "transaction": "string",
10     "merchant": "string",
11     "blockchain": "solana",
12     "wallet": "string",
13     "withdrawer": "string",
14     "transferId": "string",
15     "accountId": "string",
16     "usdToForeignExchangeRate": 1.1,
17     "userPaidFees": {
18       "swapFees": {
19         "cents": 1,
20         "currency": "USD"
21       },
22       "gasFees": {
23         "cents": 1,
24         "currency": "USD"
25       },
26       "fees": {
27         "cents": 1,
28         "currency": "USD"
29       },
30       "processingFees": {
31         "cents": 1,
32         "currency": "USD"
33       },
34       "customFees": {
35         "cents": 1,
36         "currency": "USD"
37       }
38     },
39     "merchantPaidFees": {
40       "swapFees": {
41         "cents": 1,
42         "currency": "USD"
43       },
44       "gasFees": {
45         "cents": 1,
46         "currency": "USD"
47       },
48       "fees": {
49         "cents": 1,
50         "currency": "USD"
51       },
52       "merchantFundedAmount": {
53         "cents": 1,
54         "currency": "USD"
55       },
56       "settledInline": true
57     },
58     "expectedDeliveryDate": "2024-01-15T09:30:00Z",
59     "updatedAt": "2024-01-15T09:30:00Z",
60     "provider": "string",
61     "status": "completed",
62     "idempotencyKey": "string",
63     "userLocation": {
64       "lng": 1.1,
65       "lat": 1.1,
66       "resolvedState": "string",
67       "resolvedCountry": "string"
68     },
69     "returnStatus": "pending_return",
70     "returnTransaction": "string",
71     "returnedAt": "2024-01-15T09:30:00Z",
72     "userId": "string",
73     "detailMessage": "string",
74     "errorData": "string",
75     "pin": "string",
76     "isFirstParty": true,
77     "payoutInitiated": true,
78     "manuallyFailedBy": {
79       "editor": "string",
80       "editorType": "Coinflow",
81       "ipAddress": "string",
82       "failedAt": "2024-01-15T09:30:00Z"
83     },
84     "orchestrationTraceId": "string",
85     "entityTag": {
86       "coinflowEntity": "US",
87       "licensedEntity": "string"
88     }
89   }
90 ]

Get All Withdraws associated with the merchant

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

sincestringOptional

untilstringOptional

pagedoubleOptional

statusstringOptional

searchstringOptional

sortByenumOptional

Allowed values:

sortDirectiondoubleOptional

speedstringOptional

providerstringOptional

merchantIdstringOptional

limitdoubleOptional

Response

createdAtdatetime

amountobject

speedenum

transactionstring

merchantstring or object

blockchainenum

walletstring

withdrawerstring or object

transferIdstring

accountIdstring

usdToForeignExchangeRatedouble

This is the conversion rate from USD to the foreign currency. For example 0.90 = 0.90 USD/GBP

So if you want to convert GBP to USD you would multiply 15 GBP * 0.90 USD/GBP = 13.5 USD If you want to convert USD to GBP you would multiply 13.5 USD * 1/0.90 GBP/USD = 15 GBP

userPaidFeesobject

merchantPaidFeesobject

expectedDeliveryDatedatetime

updatedAtdatetime

providerstring

statusenum

idempotencyKeystring

userLocationobject

Browser-captured geolocation at the time of the withdraw request, when the caller supplied one. Stored independently of payout method so the merchant dashboard can render a map for any withdraw. resolved* fields are populated when the GEOLOCATION enforcement step happened to reverse- geocode the coordinates — they’re a free piggyback on the lock cache, not a guarantee.

returnStatusenum

returnTransactionstring

returnedAtdatetime

userIdstring

detailMessagestring

errorDatastring

pinstring

Only used for Interac payments if the user must provide their bank a PIN to claim the transfer.

isFirstPartyboolean

True when this withdraw was a first-party payout (the merchant withdrawing from their own settlement wallet).

payoutInitiatedboolean

manuallyFailedByobject

orchestrationTraceIdstring

entityTagobject