🔒Get business withdrawals

Fetch withdrawals

get

Fetch withdrawals for a business.

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuth

AuthorizationstringRequired

^FRX-API api-key=[^,]+,signature=[^,]+,timestamp=[\d]+$

Query parameters

businessIdstring · uuidRequired

ID of the business.

clientWithdrawIdstring[]Optional

Withdrawal ID provided by the client.

afterinteger · int64Optional

Withdrawal creation date range start, in UNIX seconds, inclusive.

Example: 1702894529

beforeinteger · int64Optional

Withdrawal creation date range end, in UNIX seconds, exclusive.

Example: 1702894529

limitinteger · max: 2000Optional

Limit of the results per request.

Default: 25Example: 25

Responses

200

Returns withdrawals, sorted by created.

application/json

get

/api/v1/withdrawals

HTTPcURLJavaScriptPython

GET /api/v1/withdrawals?businessId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Returns withdrawals, sorted by created.

{
  "withdrawals": [
    {
      "withdrawId": "5724d752-6084-3822-9590-a6ccdf91f603",
      "clientWithdrawId": "test-withdrawal-23-12-19-2",
      "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
      "transactionId": "0x6a01e5032de509be3ed2075f382396a48d43ae496debbe0f1a09d0590e419a8a",
      "initiatedBy": "[email protected]",
      "status": "COMPLETED",
      "displayCurrency": "EUR",
      "withdrawCurrency": "USDC",
      "settlementCurrency": "EUR",
      "estimatedDisplayAmount": "21",
      "estimatedWithdrawAmount": "23.01742298",
      "actualDisplayAmount": "21",
      "actualWithdrawAmount": "23.01742298",
      "settlementDeductedAmount": "21.52",
      "displayDeductedAmount": "21.52",
      "uniformDeductedAmount": "21.52",
      "settlementServiceFee": "0.52",
      "displayServiceFee": "0.52",
      "uniformServiceFee": "0.52",
      "withdrawFee": "0",
      "displayFee": "0",
      "network": "BSC",
      "addressOwner": {
        "category": "Unknown",
        "name": "Unknown"
      },
      "sourceRiskEntities": [],
      "destinationRiskEntities": [],
      "createdAt": 1702999367
    },
    {
      "withdrawId": "fde3c760-2383-391e-8baf-7fb8508eca18",
      "clientWithdrawId": "test-withdrawal-23-12-19-1",
      "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
      "transactionId": "0xcf385e8b9301fb105b013d5df78c4bc09fabe604761334409e286c2c06a20cd3",
      "initiatedBy": "[email protected]",
      "status": "COMPLETED",
      "displayCurrency": "EUR",
      "withdrawCurrency": "USDC",
      "settlementCurrency": "USDC",
      "estimatedDisplayAmount": "25.33",
      "estimatedWithdrawAmount": "27.46682584",
      "actualDisplayAmount": "25.33",
      "actualWithdrawAmount": "27.46682584",
      "settlementDeductedAmount": "28.144254",
      "displayDeductedAmount": "25.63",
      "uniformDeductedAmount": "25.63",
      "settlementServiceFee": "0.330163",
      "displayServiceFee": "0.3",
      "uniformServiceFee": "0.3",
      "withdrawFee": "0",
      "displayFee": "0",
      "network": "BSC",
      "addressOwner": {
        "category": "Unknown",
        "name": "Unknown"
      },
      "sourceRiskEntities": [],
      "destinationRiskEntities": [],
      "createdAt": 1702999081
    }
  ]
}