Get Withdraws | Coinflow

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

[
  {
    "accountId": "string",
    "amount": {
      "cents": 1,
      "currency": "USD"
    },
    "blockchain": "solana",
    "createdAt": "2024-01-15T09:30:00Z",
    "expectedDeliveryDate": "2024-01-15T09:30:00Z",
    "merchant": "string",
    "merchantPaidFees": {
      "swapFees": {
        "cents": 1,
        "currency": "USD"
      },
      "gasFees": {
        "cents": 1,
        "currency": "USD"
      },
      "fees": {
        "cents": 1,
        "currency": "USD"
      }
    },
    "provider": "string",
    "speed": "asap",
    "status": "completed",
    "transaction": "string",
    "transferId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "usdToForeignExchangeRate": 1.1,
    "userPaidFees": {
      "swapFees": {
        "cents": 1,
        "currency": "USD"
      },
      "gasFees": {
        "cents": 1,
        "currency": "USD"
      },
      "fees": {
        "cents": 1,
        "currency": "USD"
      },
      "customFees": {
        "cents": 1,
        "currency": "USD"
      }
    },
    "wallet": "string",
    "withdrawer": "string",
    "detailMessage": "string",
    "errorData": "string",
    "idempotencyKey": "string",
    "manuallyFailedBy": {
      "editor": "string",
      "editorType": "Coinflow",
      "ipAddress": "string",
      "failedAt": "2024-01-15T09:30:00Z"
    },
    "payoutInitiated": true,
    "pin": "string",
    "returnStatus": "pending_return",
    "returnTransaction": "string",
    "userId": "string"
  }
]

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

accountIdstring

amountobject

blockchainenum

createdAtdatetime

expectedDeliveryDatedatetime

merchantstring or object

merchantPaidFeesobject

providerstring

speedenum

statusenum

transactionstring

transferIdstring

updatedAtdatetime

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

walletstring

withdrawerstring or object

detailMessagestring

errorDatastring

idempotencyKeystring

manuallyFailedByobject

payoutInitiatedboolean

pinstring

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

returnStatusenum

Allowed values:

returnTransactionstring

userIdstring