Przejdź do głównej zawartości

Get Withdrawal Details

GET /withdrawal/:id/

Retrieves detailed information about a specific withdrawal by its ID. This endpoint allows you to check the current status and details of any withdrawal.

Request Headers

HeaderDescription
AuthorizationBearer token for authentication: Bearer <access_token>
X-API-KeyAPI key for authentication (alternative to OAuth 2.0 token)

URL Parameters

ParameterTypeDescription
idstringThe unique identifier of the withdrawal to retrieve

Example Request

GET /withdrawal/550e8400-e29b-41d4-a716-446655440000/
Authorization: Bearer eyJ0eXAiOiJPQXV0aFRva2VuIiwiYWxnIjoiUlMyNTYifQ...

Response Parameters

ParameterTypeDescription
withdrawal_idstringUnique identifier for the withdrawal
statusstringCurrent status of the withdrawal (see Status Values table)
amountnumberWithdrawal amount
feenumberFee charged for the withdrawal
addressstringDestination wallet address
blockchainstringBlockchain network used
tokenstringToken being withdrawn
memostringMemo or tag, if provided
created_atstringISO 8601 timestamp of withdrawal creation
updated_atstringISO 8601 timestamp of last status update
completed_atstringISO 8601 timestamp of withdrawal completion (if completed)
custom_idstringYour custom identifier for this withdrawal, if provided
transaction_hashstringBlockchain transaction hash, if available
confirmationsintegerNumber of blockchain confirmations (if submitted)
required_confirmationsintegerRequired number of confirmations for completion
batch_idstringID of the withdrawal batch, if part of a batch
status_historyarrayHistorical status changes with timestamps
error_messagestringError message if status is 'failed' or 'rejected'

Example Response

{
"withdrawal_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"amount": 100.50,
"fee": 1.50,
"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"blockchain": "ETH",
"token": "USDT",
"memo": null,
"created_at": "2025-04-10T15:30:00Z",
"updated_at": "2025-04-10T16:45:12Z",
"completed_at": "2025-04-10T16:45:12Z",
"custom_id": "WITHDRAWAL-123",
"transaction_hash": "0xab5d35434fe46ef9c5d215238a3dbb42d2f3c84e7a36f80c61244ea9ac81ef73",
"confirmations": 24,
"required_confirmations": 12,
"batch_id": "batch-980cf45a",
"status_history": [
{
"status": "pending",
"timestamp": "2025-04-10T15:30:00Z"
},
{
"status": "approved",
"timestamp": "2025-04-10T15:45:23Z"
},
{
"status": "processing",
"timestamp": "2025-04-10T16:00:05Z"
},
{
"status": "submitted",
"timestamp": "2025-04-10T16:10:30Z"
},
{
"status": "confirmed",
"timestamp": "2025-04-10T16:35:45Z"
},
{
"status": "completed",
"timestamp": "2025-04-10T16:45:12Z"
}
],
"error_message": null
}

Status Values

StatusDescriptionWhen to Expect
pendingInitial status; withdrawal has been created but not yet processedWhen withdrawal is created

| confirmed | Transaction has received the required number of confirmations | When blockchain confirms the transaction | | completed | Withdrawal has been fully processed and is complete | When all processing is done | | rejected | Withdrawal was rejected during review | If the withdrawal is rejected | | failed | Withdrawal failed during processing | If blockchain or system errors occur | | cancelled | Withdrawal was cancelled by the user or an administrator | If the withdrawal is canceled |

Webhook Events

When a withdrawal status changes, a webhook notification is sent to your callback URL with the standardized event type withdrawal_status_update. The webhook payload includes the withdrawal details, current status, and previous status. See our Implementing Webhook Callbacks guide for details on how to handle these notifications.

Error Codes

Status CodeError CodeDescription
401unauthorizedAuthentication failed or token is missing
403forbiddenInsufficient permissions to view this withdrawal
404not_foundThe specified withdrawal does not exist or belongs to another user
429rate_limit_exceededToo many requests in a short period

Notes

  • The transaction_hash field is only available for withdrawals that have been submitted to the blockchain
  • The confirmations field indicates how many blockchain confirmations the transaction has received
  • The required_confirmations field indicates how many confirmations are required for the withdrawal to be considered complete
  • The status_history array provides a complete history of all status changes for the withdrawal
  • The error_message field is only populated if the withdrawal has failed or been rejected
  • The batch_id field is only present if the withdrawal is part of a processing batch
  • The status values match those used in webhook notifications, providing a consistent status lifecycle across the API

Transaction Verification

Once a withdrawal has the status submitted or later, you can verify the transaction on the blockchain using the transaction_hash and the following blockchain explorers:

Webhook Integration

For real-time status updates, we recommend implementing webhook handling for withdrawal status changes. This will allow your application to automatically process status updates without polling this endpoint. See our Webhook Reference documentation for detailed information about webhook formats and implementation best practices.