🔒Get business withdrawals

Fetch withdrawals

Fetch withdrawals for a business.

GET/api/v1/withdrawals

Authorization

ApiKeyAuth

Query parameters

Response

200

Returns withdrawals, sorted by created.

Body

application/json

withdrawalsarray of FetchWithdrawalResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/withdrawals?businessId=123e4567-e89b-12d3-a456-426614174000', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "withdrawals": [
    {
      "withdrawId": "123e4567-e89b-12d3-a456-426614174000",
      "clientWithdrawId": "text",
      "recipientAddress": "text",
      "transactionId": "text",
      "initiatedBy": "text",
      "status": "PENDING",
      "displayCurrency": "AED",
      "withdrawCurrency": "BCH",
      "settlementCurrency": "BTC",
      "estimatedDisplayAmount": "text",
      "estimatedWithdrawAmount": "text",
      "actualDisplayAmount": "text",
      "actualWithdrawAmount": "text",
      "settlementDeductedAmount": "text",
      "displayDeductedAmount": "text",
      "uniformDeductedAmount": "text",
      "settlementServiceFee": "text",
      "displayServiceFee": "text",
      "uniformServiceFee": "text",
      "withdrawFee": "text",
      "displayFee": "text",
      "network": "BCH",
      "addressOwner": {
        "name": "text",
        "category": "text"
      },
      "sourceRiskEntities": [
        {
          "name": "text",
          "category": "text"
        }
      ],
      "destinationRiskEntities": [
        {
          "name": "text",
          "category": "text"
        }
      ],
      "createdAt": 0
    }
  ]
}